Are you REALLY sure you want to continue?"; + $userx['delete_title'] = "Survey unit sessions should not be deleted"; + } + + $users[$i] = $userx; + } + + $this->setView('advanced/user_detail', array( + 'users' => $users, + 'pagination' => $table['pagination'], + 'position_lt' => $queryparams['position_operator'], + 'querystring' => $querystring, + )); + + return $this->sendResponse(); + } + + private function getUserDetailTable($queryParams, $page = null) { + $query = array(); + if (!empty($queryParams['run_name'])) { + $query[] = ' `survey_runs`.name LIKE :run_name '; + } + + if (!empty($queryParams['session'])) { + $query[] = ' `survey_run_sessions`.session LIKE :session '; + } + + if (!empty($queryParams['position'])) { + $query[] = " `survey_run_units`.position {$queryParams['position_operator']} :position "; + } + unset($queryParams['position_operator']); + + if(count($query) > 0 ) { + $where = "WHERE " . implode(' AND ', $query); + } else { + $where = ""; + } + + $itemsQuery = "SELECT + `survey_run_sessions`.session, + `survey_unit_sessions`.id AS session_id, + `survey_runs`.name AS run_name, + `survey_run_units`.position, + `survey_run_units`.description, + `survey_units`.type AS unit_type, + `survey_unit_sessions`.created, + `survey_unit_sessions`.ended, + `survey_unit_sessions`.expired, + `survey_unit_sessions`.expires, + `survey_unit_sessions`.`queued`, + `survey_unit_sessions`.result, + `survey_unit_sessions`.result_log + FROM `survey_unit_sessions` + LEFT JOIN `survey_run_sessions` ON `survey_run_sessions`.id = `survey_unit_sessions`.run_session_id + LEFT JOIN `survey_units` ON `survey_unit_sessions`.unit_id = `survey_units`.id + LEFT JOIN `survey_run_units` ON `survey_unit_sessions`.unit_id = `survey_run_units`.unit_id + LEFT JOIN `survey_runs` ON `survey_runs`.id = `survey_run_units`.run_id + {$where} + ORDER BY `survey_run_sessions`.id DESC,`survey_unit_sessions`.id ASC LIMIT 1000 + "; + + return array( + 'data' => $this->fdb->execute($itemsQuery, $queryParams), + 'pagination' => "", + ); + } + +} diff --git a/application/Controller/AdminAjaxController.php b/application/Controller/AdminAjaxController.php index 84ed59127..e33a95d4d 100644 --- a/application/Controller/AdminAjaxController.php +++ b/application/Controller/AdminAjaxController.php @@ -8,519 +8,502 @@ */ class AdminAjaxController { - /** - * - * @var AdminController - */ - protected $controller; - - /** - * - * @var Site - */ - protected $site; - - /** - * @var Request - */ - protected $request; - - /** - * - * @var DB - */ - protected $dbh; - - public function __construct(AdminController $controller) { - $this->controller = $controller; - $this->site = $controller->getSite(); - $this->dbh = $controller->getDB(); - $this->request = new Request(); - } - - public static function call($method, AdminController $controller) { - $self = new self($controller); - $action = $self->getPrivateAction($method); - return $self->$action(); - } - - private function ajaxCreateRunUnit() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - - $unit = $this->controller->createRunUnit(); - if ($unit->valid) { - $unit->addToRun($this->controller->run->id, $unit->position); - alert('Success. ' . ucfirst($unit->type) . ' unit was created.', 'alert-success'); - $response = $unit->displayForRun($this->site->renderAlerts()); - } else { - bad_request_header(); - $msg = 'Sorry. Run unit could not be created.'; - if (!empty($unit)) { - $msg .= implode("\n", $unit->errors); - } - alert($msg, 'alert-danger'); - $response = $this->site->renderAlerts(); - } - - echo $response; - exit; - } - - private function ajaxGetUnit() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - - $run = $this->controller->run; - $dbh = $this->dbh; - - if ($run_unit_id = $this->request->getParam('run_unit_id')) { - $special = $this->request->getParam('special'); - - $unit_info = $run->getUnitAdmin($run_unit_id, $special); - $unit_factory = new RunUnitFactory(); - $unit = $unit_factory->make($dbh, null, $unit_info, null, $run); - - $response = $unit->displayForRun(); - } else { - bad_request_header(); - $msg = 'Sorry. Missing run unit.'; - if (!empty($unit)) { - $msg .= implode("\n", $unit->errors); - } - alert($msg, 'alert-danger'); - $response = $this->site->renderAlerts(); - } - - echo $response; - exit; - } - - private function ajaxRemind() { - if ($this->request->bool('get_count') === true) { - $sessions = $this->getSessionRemindersSent($this->request->int('run_session_id')); - $count = array(); - foreach ($sessions as $sess) { - if (!isset($count[$sess['unit_id']])) { - $count[$sess['unit_id']] = 0; - } + /** + * + * @var AdminController + */ + protected $controller; + + /** + * + * @var Site + */ + protected $site; + + /** + * @var Request + */ + protected $request; + + /** + * + * @var Response + */ + protected $response; + + /** + * + * @var DB + */ + protected $dbh; + + public function __construct(AdminController $controller) { + $this->controller = $controller; + $this->site = $controller->getSite(); + $this->dbh = $controller->getDB(); + $this->request = new Request(); + $this->response = new Response(); + } + + /** + * Execute the corresponding ajax method + * + * @param string $method + * @param AdminController $controller + * + * @return Response + */ + public static function call($method, AdminController $controller) { + $self = new self($controller); + $action = $self->getPrivateAction($method); + $self->$action(); + return $self->response; + } + + private function ajaxCreateRunUnit() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + + $unit = $this->controller->createRunUnit(); + if ($unit->valid) { + //$unit->addToRun($this->controller->run->id, $unit->position); + alert('Success. ' . ucfirst($unit->type) . ' unit was created.', 'alert-success'); + $content = $unit->displayForRun($this->site->renderAlerts()); + } else { + $this->response->setStatusCode(500, 'Bad Request'); + $msg = 'Sorry. Run unit could not be created.'; + $msg .= !empty($unit) ? implode("\n", $unit->errors) : ''; + alert($msg, 'alert-danger'); + $content = $this->site->renderAlerts(); + } + + return $this->response->setContent($content); + } + + private function ajaxGetUnit() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + + $run = $this->controller->run; + + if ($id = $this->request->getParam('unit_id')) { + $params = $this->request->getParams(); + $params['id'] = (int) $id; + $unit = RunUnitFactory::make($run, $params); + $content = $unit->displayForRun(); + } else { + $this->response->setStatusCode(500, 'Bad Request'); + $msg = 'Sorry. Missing run unit.'; + $msg .= !empty($unit) ? implode("\n", $unit->errors) : ''; + alert($msg, 'alert-danger'); + $content = $this->site->renderAlerts(); + } + + $this->response->setContent($content); + } + + private function ajaxRemind() { + if ($this->request->bool('get_count') === true) { + $sessions = $this->getSessionRemindersSent($this->request->int('run_session_id')); + $count = array(); + foreach ($sessions as $sess) { + if (!isset($count[$sess['unit_id']])) { + $count[$sess['unit_id']] = 0; + } $count[$sess['unit_id']]++; - } - return $this->outjson($count); - } - - $run = $this->controller->run; - // find the last email unit - $email = $run->getReminder($this->request->getParam('reminder'), $this->request->getParam('session'), $this->request->getParam('run_session_id')); - $email->run_session = new RunSession($this->dbh, $run->id, null, $this->request->getParam('session'), $run); - if ($email->exec() !== false) { - alert('Something went wrong with the reminder. Run: ' . $run->name, 'alert-danger'); - } else { - alert('Reminder sent!', 'alert-success'); - } - $email->end(); - - if (is_ajax_request()) { - echo $this->site->renderAlerts(); - exit; - } else { - redirect_to(admin_run_url($run->name, 'user_overview')); - } - } - - private function ajaxToggleTesting() { - $run = $this->controller->run; - $dbh = $this->dbh; - - $run_session = new RunSession($dbh, $run->id, null, $this->request->getParam('session'), $run); - - $status = $this->request->getParam('toggle_on') ? 1: 0; - $run_session->setTestingStatus($status); - - if (is_ajax_request()) { - echo $this->site->renderAlerts(); - exit; - } else { - redirect_to(admin_run_url($run->name, 'user_overview')); - } - } - - private function ajaxSendToPosition() { - $run = $this->controller->run; - $dbh = $this->dbh; - - $run_session = new RunSession($dbh, $run->id, null, $this->request->str('session'), $run); - $new_position = $this->request->int('new_position'); - - if (!$run_session->forceTo($new_position)) { - alert('Something went wrong with the position change. Run: ' . $run->name, 'alert-danger'); - bad_request_header(); - } - - if (is_ajax_request()) { - echo $this->site->renderAlerts(); - exit; - } else { - redirect_to(admin_run_url($run->name, 'user_overview')); - } - } - - private function ajaxNextInRun() { - $run = $this->controller->run; - $dbh = $this->dbh; - - $run_session = new RunSession($dbh, $run->id, null, $_GET['session'], $run); - - if (!$run_session->endUnitSession()) { - alert('Something went wrong with the unpause. in run ' . $run->name, 'alert-danger'); - bad_request_header(); - } - - if (is_ajax_request()) { - echo $this->site->renderAlerts(); - exit; - } else { - redirect_to(admin_run_url($run->name, 'user_overview')); - } - } - - private function ajaxSnipUnitSession() { - $run = $this->controller->run; - $dbh = $this->dbh; - $run_session = new RunSession($dbh, $run->id, null, $this->request->getParam('session'), $run); - - $unit_session = $run_session->getUnitSession(); - if($unit_session) { - $deleted = $dbh->delete('survey_unit_sessions', array('id' => $unit_session->id)); - if($deleted) { - alert('Success. You deleted the data at the current position.', 'alert-success'); - } else { - alert('Couldn\'t delete.', 'alert-danger'); - bad_request_header(); - } - } else { - alert("No unit session found", 'alert-danger'); - } - - if (is_ajax_request()) { - echo $this->site->renderAlerts(); - exit; - } else { - redirect_to(admin_run_url($run->name, 'user_overview')); - } - } - - private function ajaxDeleteUser() { - $run = $this->controller->run; - $deleted = $this->dbh->delete('survey_run_sessions', array('id' => $this->request->getParam('run_session_id'))); - if ($deleted) { - alert('User with session ' . h($_GET['session']) . ' was deleted.', 'alert-info'); - } else { - alert('User with session ' . h($_GET['session']) . ' could not be deleted.', 'alert-warning'); - bad_request_header(); - } - - if (is_ajax_request()) { - echo $this->site->renderAlerts(); - exit; - } else { - redirect_to(admin_run_url($run->name, 'user_overview')); - } - } - - private function ajaxDeleteUnitSession() { - $run = $this->controller->run; - $del = $this->dbh->prepare('DELETE FROM `survey_unit_sessions` WHERE id = :id'); - $del->bindValue(':id', $this->request->str('session_id')); - - if($del->execute()) { - alert('Success. You deleted this unit session.','alert-success'); - } else { - alert('Couldn\'t delete. Sorry.
'. print_r($del->errorInfo(), true).'','alert-danger'); - bad_request_header(); - } - - if (is_ajax_request()) { - echo $this->site->renderAlerts(); - exit; - } else { - redirect_to(admin_run_url($run->name, 'user_detail')); - } - } - - private function ajaxRemoveRunUnitFromRun() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - - $run = $this->controller->run; - $dbh = $this->dbh; - - if (($run_unit_id = $this->request->getParam('run_unit_id'))) { - $special = $this->request->getParam('special'); - - $unit_info = $run->getUnitAdmin($run_unit_id, $special); - $unit_factory = new RunUnitFactory(); - /* @var $unit RunUnit */ - $unit = $unit_factory->make($dbh, null, $unit_info, null, $run); - if (!$unit) { - formr_error(404, 'Not Found', 'Requested Run Unit was not found'); - } - $sess_key = __METHOD__ . $unit->id; - $results = $unit->howManyReachedItNumbers(); - $has_sessions = $results && (array_val($results, 'begun') || array_val($results, 'finished') || array_val($results, 'expired')); - - if ($has_sessions && !Session::get($sess_key)) { - Session::set($sess_key, $unit->id); - echo 'warn'; - exit; - } elseif (!$has_sessions || (Session::get($sess_key) === $unit->id && $this->request->getParam('confirm') === 'yes')) { - if ($unit->removeFromRun($special)) { - alert('Success. Unit with ID ' . $this->request->run_unit_id . ' was deleted.', 'alert-success'); - } else { - bad_request_header(); - $alert_msg = 'Sorry, could not remove unit. '; - $alert_msg .= implode($unit->errors); - alert($alert_msg, 'alert-danger'); - } - } - } - - Session::delete($sess_key); - echo $this->site->renderAlerts(); - exit; - } - - private function ajaxReorder() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - - $run = $this->controller->run; - $positions = $this->request->arr('position'); - if ($positions) { - $unit = $run->reorder($positions); - $response = ''; - } else { - bad_request_header(); - $msg = 'Sorry. Re-ordering run units failed.'; - if (!empty($unit)) { - $msg .= implode("\n", $unit->errors); - } - alert($msg, 'alert-danger'); - $response = $this->site->renderAlerts(); - } - - echo $response; - exit; - } - - private function ajaxRunImport() { - $run = $this->controller->run; - $site = $this->site; - - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - - // If only showing dialog then show it and exit - $dialog_only = $site->request->bool('dialog'); - if ($dialog_only) { - // Read on exported runs from configured directory - $dir = Config::get('run_exports_dir'); - if (!($exports = (array) get_run_dir_contents($dir))) { - $exports = array(); - } - - Template::load('admin/run/run_import_dialog', array('exports' => $exports, 'run' => $this->controller->run)); - exit; - } - } - - private function ajaxRunLockedToggle() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - $run = $this->controller->run; - $lock = $this->request->int('on'); - if (in_array($lock, array(0, 1))) { - $run->toggleLocked($lock); - } - } - - private function ajaxRunPublicToggle() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - $run = $this->controller->run; - $pub = $this->request->int('public'); - if (!$run->togglePublic($pub)) { - bad_request_header(); - } - } - - private function ajaxSaveRunUnit() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - - $run = $this->controller->run; - $dbh = $this->dbh; - $response = ''; - - $unit_factory = new RunUnitFactory(); - if ($run_unit_id = $this->request->getParam('run_unit_id')) { - $special = $this->request->getParam('special'); - $unit_info = $run->getUnitAdmin($run_unit_id, $special); - - $unit = $unit_factory->make($dbh, null, $unit_info, null, $run); - $unit->create($_POST); - if ($unit->valid && ($unit->hadMajorChanges() || !empty($this->site->alerts))) { - $response = $unit->displayForRun($this->site->renderAlerts()); - } - } else { - bad_request_header(); - $alert_msg = "Sorry. Something went wrong while saving. Please contact formr devs, if this problem persists."; - if (!empty($unit)) { - $alert_msg .= implode("\n", $unit->errors); - } - alert($alert_msg, 'alert-danger'); - $response = $this->site->renderAlerts(); - } - - echo $response; - exit; - } - - private function ajaxSaveSettings() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - - $run = $this->controller->run; - $post = new Request($_POST); - if ($run->saveSettings($post->getParams())) { - alert('Settings saved', 'alert-success'); - } else { - bad_request_header(); - alert('Error. ' . implode(".\n", $run->errors), 'alert-danger'); - } - - echo $this->site->renderAlerts(); - } - - private function ajaxTestUnit() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - - $run = new Run($this->dbh, $this->controller->run->name); - - if ($run_unit_id = $this->request->getParam('run_unit_id')) { - $special = $this->request->getParam('special'); - $unit = $run->getUnitAdmin($run_unit_id, $special); - $unit_factory = new RunUnitFactory(); - $unit = $unit_factory->make($this->dbh, null, $unit, null, $run); - $unit->test(); - } else { - bad_request_header(); - $alert_msg = "Sorry. An error occured during the test."; - if (isset($unit)) { - $alert_msg .= implode("\n", $unit->errors); - } - alert($alert_msg, 'alert-danger'); - } - - echo $this->site->renderAlerts(); - exit; - } - - private function ajaxUserBulkActions() { - if (!is_ajax_request()) { - formr_error(406, 'Not Acceptable'); - } - - $action = $this->request->str('action'); - $sessions = $this->request->arr('sessions'); - $qs = $res = array(); - if (!$action || !$sessions) { - formr_error(500); - exit; - } - foreach ($sessions as $session) { - $qs[] = $this->dbh->quote($session); - } - $count = count($sessions); - if ($action === 'toggleTest') { - $query = 'UPDATE survey_run_sessions SET testing = 1 - testing WHERE session IN ('. implode(',', $qs) . ')'; - $this->dbh->query($query); - alert("{$count} selected session(s) were successfully modified", 'alert-success'); - $res['success'] = true; - } elseif ($action === 'sendReminder') { - $run = $this->controller->run; - $count = 0; - foreach ($sessions as $sess) { - $runSession = new RunSession($this->dbh, $run->id, null, $sess, $run); - $email = $run->getReminder($this->request->int('reminder'), $sess, $runSession->id); - $email->run_session = $runSession; - if ($email->exec() === false) { - $count++; - } - $email->end(); - } - - if ($count) { - alert("{$count} session(s) have been sent the reminder '{$email->getSubject()}'", 'alert-success'); - $res['success'] = true; - } else { - $res['error'] = $this->site->renderAlerts(); - } - } elseif ($action === 'deleteSessions') { - $query = 'DELETE FROM survey_run_sessions WHERE session IN ('. implode(',', $qs) . ')'; - $this->dbh->query($query); - alert("{$count} selected session(s) were successfully deleted", 'alert-success'); - $res['success'] = true; - } elseif ($action === 'positionSessions') { - $query = 'UPDATE survey_run_sessions SET position = ' . $this->request->int('pos') . ' WHERE session IN ('. implode(',', $qs) . ')'; - $this->dbh->query($query); - alert("{$count} selected session(s) were successfully moved", 'alert-success'); - $res['success'] = true; - } - - $this->outjson($res); - } - - protected function getPrivateAction($name) { - $parts = array_filter(explode('_', $name)); - $action = array_shift($parts); - $class = __CLASS__; - foreach ($parts as $part) { - $action .= ucwords(strtolower($part)); - } - if (!method_exists($this, $action)) { - throw new Exception("Action '$name' is not found in $class."); - } - return $action; - } - - protected function getSessionRemindersSent($run_session_id) { - $stmt = $this->dbh->prepare( - 'SELECT survey_unit_sessions.id as unit_session_id, survey_run_special_units.id as unit_id FROM survey_unit_sessions - LEFT JOIN survey_units ON survey_unit_sessions.unit_id = survey_units.id - LEFT JOIN survey_run_special_units ON survey_run_special_units.id = survey_units.id - WHERE survey_unit_sessions.run_session_id = :run_session_id AND survey_run_special_units.type = "ReminderEmail" - '); - $stmt->bindValue('run_session_id', $run_session_id, PDO::PARAM_INT); - $stmt->execute(); - return $stmt->fetchAll(PDO::FETCH_ASSOC); - } - - protected function outjson($res) { - header('Content-Type: application/json'); - echo json_encode($res); - exit(0); - } + } + + $this->response->setContentType('application/json'); + return $this->response->setJsonContent($count); + } + + $run = $this->controller->run; + + // find the last email unit + $emailSession = $run->getReminderSession($this->request->getParam('reminder'), $this->request->getParam('session'), $this->request->getParam('run_session_id')); + if ($emailSession->execute() === false) { + alert('Something went wrong with the reminder. Run: ' . $run->name, 'alert-danger'); + } else { + alert('Reminder sent!', 'alert-success'); + } + + if (Request::isAjaxRequest()) { + $content = $this->site->renderAlerts(); + return $this->response->setContent($content); + } else { + $this->request->redirect(admin_run_url($run->name, 'user_overview')); + } + } + + private function ajaxToggleTesting() { + $run = $this->controller->run; + $dbh = $this->dbh; + + $run_session = new RunSession($this->request->getParam('session'), $run); + + $status = $this->request->getParam('toggle_on') ? 1 : 0; + $run_session->setTestingStatus($status); + + if (Request::isAjaxRequest()) { + $content = $this->site->renderAlerts(); + return $this->response->setContent($content); + } else { + $this->request->redirect(admin_run_url($run->name, 'user_overview')); + } + } + + private function ajaxSendToPosition() { + $run = $this->controller->run; + $dbh = $this->dbh; + + $runSession = new RunSession($this->request->str('session'), $run); + $position = $this->request->int('new_position'); + + if (!$runSession->forceTo($position)) { + alert('Something went wrong with the position change. Run: ' . $run->name, 'alert-danger'); + $this->response->setStatusCode(500, 'Bad Request'); + } else { + // execute current unit but don't return ouput + $runSession->execute(); + alert('Session has been moved to desired position. If moved to a Branching Unit the session might have moved on.', 'alert-info'); + } + + if (Request::isAjaxRequest()) { + $content = $this->site->renderAlerts(); + return $this->response->setContent($content); + } else { + $this->request->redirect(admin_run_url($run->name, 'user_overview')); + } + } + + private function ajaxNextInRun() { + $run = $this->controller->run; + $dbh = $this->dbh; + + $run_session = new RunSession($_GET['session'], $run); + + if (!$run_session->endCurrentUnitSession()) { + alert('Something went wrong with the unpause. in run ' . $run->name, 'alert-danger'); + $this->response->setStatusCode(500, 'Bad Request'); + } + + if (Request::isAjaxRequest()) { + $content = $this->site->renderAlerts(); + return $this->response->setContent($content); + } else { + $this->request->redirect(admin_run_url($run->name, 'user_overview')); + } + } + + private function ajaxSnipUnitSession() { + $run = $this->controller->run; + $dbh = $this->dbh; + $run_session = new RunSession($this->request->getParam('session'), $run); + + $unit_session = $run_session->getCurrentUnitSession(); + if ($unit_session) { + $deleted = $dbh->delete('survey_unit_sessions', array('id' => $unit_session->id)); + if ($deleted) { + alert('Success. You deleted the data at the current position.', 'alert-success'); + } else { + alert('Couldn\'t delete.', 'alert-danger'); + $this->response->setStatusCode(500, 'Bad Request'); + } + } else { + alert("No unit session found", 'alert-danger'); + } + + if (Request::isAjaxRequest()) { + $content = $this->site->renderAlerts(); + return $this->response->setContent($content);; + } else { + $this->request->redirect(admin_run_url($run->name, 'user_overview')); + } + } + + private function ajaxDeleteUser() { + $run = $this->controller->run; + $deleted = $this->dbh->delete('survey_run_sessions', array('id' => $this->request->getParam('run_session_id'), 'run_id' => $run->id)); + if ($deleted) { + alert('User with session ' . h($_GET['session']) . ' was deleted.', 'alert-info'); + } else { + alert('User with session ' . h($_GET['session']) . ' could not be deleted.', 'alert-warning'); + $this->response->setStatusCode(500, 'Bad Request'); + } + + if (Request::isAjaxRequest()) { + $content = $this->site->renderAlerts(); + return $this->response->setContent($content); + } else { + $this->request->redirect(admin_run_url($run->name, 'user_overview')); + } + } + + private function ajaxDeleteUnitSession() { + $run = $this->controller->run; + $deleted = $this->dbh->delete('survey_unit_sessions', array('id' => $this->request->int('session_id'))); + + if ($deleted) { + alert('Success. You deleted this unit session.', 'alert-success'); + } else { + alert('Couldn\'t delete. ', 'alert-danger'); + $this->response->setStatusCode(500, 'Bad Request'); + } + + if (Request::isAjaxRequest()) { + $content = $this->site->renderAlerts(); + return $this->response->setContent($content);; + } else { + $this->request->redirect(admin_run_url($run->name, 'user_detail')); + } + } + + private function ajaxRemoveRunUnitFromRun() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + + $run = $this->controller->run; + $dbh = $this->dbh; + + if (($run_unit_id = $this->request->getParam('run_unit_id'))) { + $unit = RunUnit::findByRunUnitId($run_unit_id, $this->request->getParams()); + if (!$unit) { + formr_error(404, 'Not Found', 'Requested Run Unit was not found'); + } + + $sess_key = __METHOD__ . $unit->id; + $results = $unit->getUnitSessionsCount(); + + $has_sessions = $results && (array_val($results, 'begun') || array_val($results, 'finished') || array_val($results, 'expired')); + + if ($has_sessions && !Session::get($sess_key)) { + Session::set($sess_key, $unit->id); + $content = 'warn'; + return $this->response->setContent($content); + } elseif (!$has_sessions || (Session::get($sess_key) === $unit->id && $this->request->getParam('confirm') === 'yes')) { + if ($unit->removeFromRun($this->request->getParam('special'))) { + alert('Success. Unit with ID ' . $this->request->run_unit_id . ' was deleted.', 'alert-success'); + } else { + $this->response->setStatusCode(500, 'Bad Request'); + $alert_msg = 'Sorry, could not remove unit. '; + $alert_msg .= implode($unit->errors); + alert($alert_msg, 'alert-danger'); + } + } + } + + Session::delete($sess_key); + $content = $this->site->renderAlerts(); + return $this->response->setContent($content); + } + + private function ajaxReorder() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + + $run = $this->controller->run; + $positions = $this->request->arr('position'); + if ($positions) { + $unit = $run->reorder($positions); + $content = ''; + } else { + $this->response->setStatusCode(500, 'Bad Request'); + $msg = 'Sorry. Re-ordering run units failed.'; + $msg .= !empty($unit) ? implode("\n", $unit->errors) : ''; + alert($msg, 'alert-danger'); + $content = $this->site->renderAlerts(); + } + + return $this->response->setContent($content); + } + + private function ajaxRunImport() { + $run = $this->controller->run; + $site = $this->site; + + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + + // If only showing dialog then show it and exit + $dialog_only = $site->request->bool('dialog'); + if ($dialog_only) { + // Read on exported runs from configured directory + $dir = Config::get('run_exports_dir'); + if (!($exports = (array) get_run_dir_contents($dir))) { + $exports = array(); + } + + $view = new View('admin/run/run_import_dialog', array( + 'exports' => $exports, + 'run' => $this->controller->run + )); + return $this->response->setContent($view->render()); + } + } + + private function ajaxRunLockedToggle() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + $run = $this->controller->run; + $lock = $this->request->int('on'); + if (in_array($lock, array(0, 1))) { + return $run->toggleLocked($lock); + } + } + + private function ajaxRunPublicToggle() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + $run = $this->controller->run; + $pub = $this->request->int('public'); + if (!$run->togglePublic($pub)) { + $this->response->setStatusCode(500, 'Bad Request'); + } + } + + private function ajaxSaveRunUnit() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + + $run = $this->controller->run; + $content = ''; + + if ($id = $this->request->getParam('unit_id')) { + $params = $this->request->getParams(); + $params['id'] = (int) $id; + if (!empty($params['position']) && is_array($params['position'])) { + $params['position'] = array_shift($params['position']); + } + + $unit = RunUnitFactory::make($run, $params); + $unit->create($params); + + if ($unit->valid) { + $content = $unit->displayForRun($this->site->renderAlerts()); + } + } else { + $this->response->setStatusCode(500, 'Bad Request'); + $alert_msg = "Sorry. Something went wrong while saving. Please contact formr devs, if this problem persists."; + if (!empty($unit)) { + $alert_msg .= implode("\n", $unit->errors); + } + alert($alert_msg, 'alert-danger'); + $content = $this->site->renderAlerts(); + } + + return $this->response->setContent($content); + } + + private function ajaxSaveSettings() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + + $run = $this->controller->run; + $post = new Request($_POST); + if ($run->saveSettings($post->getParams())) { + alert('Settings saved', 'alert-success'); + } else { + $this->response->setStatusCode(500, 'Bad Request'); + alert('Error. ' . implode(".\n", $run->errors), 'alert-danger'); + } + + $content = $this->site->renderAlerts(); + return $this->response->setContent($content); + } + + private function ajaxTestUnit() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + + if ($run_unit_id = $this->request->getParam('run_unit_id')) { + $unit = RunUnit::findByRunUnitId($run_unit_id, $this->request->getParams()); + $test_content = $unit->test(); + $content = $this->site->renderAlerts(); + $content .= $test_content; + } else { + $this->response->setStatusCode(500, 'Bad Request'); + $alert_msg = "Sorry. An error occured during the test."; + $alert_msg .= isset($unit) ? implode("\n", $unit->errors) : ''; + alert($alert_msg, 'alert-danger'); + $content = $this->site->renderAlerts(); + } + + return $this->response->setContent($content); + } + + private function ajaxUserBulkActions() { + if (!Request::isAjaxRequest()) { + formr_error(406, 'Not Acceptable'); + } + + $action = $this->request->str('action'); + $sessions = $this->request->arr('sessions'); + $qs = $res = array(); + if (!$action || !$sessions) { + $this->response->setStatusCode(500, 'Bad Request'); + return $this->response->setContent('Missing Parameters'); + } + + if ($action === 'toggleTest') { + $count = RunSession::toggleTestingStatus($sessions); + alert("{$count} selected session(s) were successfully modified", 'alert-success'); + $res['success'] = true; + } elseif ($action === 'sendReminder') { + $run = $this->controller->run; + $count = 0; + foreach ($sessions as $sess) { + $emailSession = $run->getReminderSession($this->request->int('reminder'), $sess, null); + if ($emailSession->execute() !== false) { + $count++; + } + //$email->end(); + } + + if ($count) { + alert("{$count} session(s) have been sent the reminder '{$emailSession->runUnit->getSubject($emailSession)}'", 'alert-success'); + $res['success'] = true; + } else { + $res['error'] = $this->site->renderAlerts(); + } + } elseif ($action === 'deleteSessions') { + $count = RunSession::deleteSessions($sessions); + alert("{$count} selected session(s) were successfully deleted", 'alert-success'); + $res['success'] = true; + } elseif ($action === 'positionSessions') { + $count = RunSession::positionSessions($this->controller->run, $sessions, $this->request->int('pos')); + alert("{$count} selected session(s) were successfully moved", 'alert-success'); + $res['success'] = true; + } + + $this->response->setContentType('application/json'); + return $this->response->setJsonContent($res); + } + + protected function getPrivateAction($name) { + $parts = array_filter(explode('_', $name)); + $action = array_shift($parts); + $class = __CLASS__; + foreach ($parts as $part) { + $action .= ucwords(strtolower($part)); + } + if (!method_exists($this, $action)) { + throw new Exception("Action '$name' is not found in $class."); + } + return $action; + } + + protected function getSessionRemindersSent($run_session_id) { + return RunSession::getSentRemindersBySessionId($run_session_id); + } } diff --git a/application/Controller/AdminController.php b/application/Controller/AdminController.php index b04d4214c..19aaa8602 100644 --- a/application/Controller/AdminController.php +++ b/application/Controller/AdminController.php @@ -2,144 +2,122 @@ class AdminController extends Controller { - public function __construct(Site &$site) { - parent::__construct($site); - $this->header(); - if (!Request::isAjaxRequest()) { - $default_assets = get_default_assets('admin'); - $this->registerAssets($default_assets); - $this->registerAssets('ace'); - } - } - - public function indexAction() { - $this->renderView('home', array( - 'runs' => $this->user->getRuns('id DESC', 5), - 'studies' => $this->user->getStudies('id DESC', 5), - )); - } - - public function infoAction() { - $this->renderView('misc/info'); - } -/* - public function cronAction() { - $this->renderView('misc/cron', array("fdb"=> $this->fdb)); - } - - public function cronForkedAction() { - $this->renderView('misc/cron_forked'); - } -*/ - public function testOpencpuAction() { - $this->renderView('misc/test_opencpu'); - } - - public function testOpencpuSpeedAction() { - $this->renderView('misc/test_opencpu_speed'); - } - - public function osfAction() { - if (!($token = OSF::getUserAccessToken($this->user))) { - redirect_to('api/osf/login'); - } - - $osf = new OSF(Config::get('osf')); - $osf->setAccessToken($token); - - if (Request::isHTTPPostRequest() && $this->request->getParam('osf_action') === 'export-run') { - $run = new Run($this->fdb, $this->request->getParam('formr_project')); - $osf_project = $this->request->getParam('osf_project'); - if (!$run->valid || !$osf_project) { - throw new Exception('Invalid Request'); - } - - $unitIds = $run->getAllUnitTypes(); - $units = array(); - $factory = new RunUnitFactory(); - - /* @var RunUnit $u */ - foreach ($unitIds as $u) { - $unit = $factory->make($this->fdb, null, $u, null, $run); - $ex_unit = $unit->getExportUnit(); - $ex_unit['unit_id'] = $unit->id; - $units[] = (object) $ex_unit; - } - - $export = $run->export($run->name, $units, true); - $export_file = Config::get('survey_upload_dir') . '/run-' . time() . '-' . $run->name . '.json'; - $create = file_put_contents($export_file, json_encode($export, JSON_PRETTY_PRINT + JSON_UNESCAPED_UNICODE + JSON_NUMERIC_CHECK)); - $response = $osf->upload($osf_project, $export_file, $run->name . '-' . date('YmdHis') . '.json'); - @unlink($export_file); - - if (!$response->hasError()) { - $run->saveSettings(array('osf_project_id' => $osf_project)); - alert('Run exported to OSF', 'alert-success'); - } else { - alert($response->getError(), 'alert-danger'); - } - - if ($redirect = $this->request->getParam('redirect')) { - redirect_to($redirect); - } - } - - // @todo implement get projects recursively - $response = $osf->getProjects(); - $osf_projects = array(); - if ($response->hasError()) { - alert($response->getError(), 'alert-danger'); - } else { - foreach ($response->getJSON()->data as $project) { - $osf_projects[] = array('id' => $project->id, 'name' => $project->attributes->title); - } - } - - $this->renderView('misc/osf', array( - 'token' => $token, - 'runs' => $this->user->getRuns(), - 'run_selected'=> $this->request->getParam('run'), - 'osf_projects' => $osf_projects, - )); - } - - protected function renderView($template, $vars = array()) { - $template = 'admin/' . $template; - parent::renderView($template, $vars); - } - - protected function header() { - if (!$this->user->loggedIn()) { - alert('You need to login to access the admin section', 'alert-warning'); - redirect_to('login'); - } - - if (!$this->user->isAdmin()) { - alert('You need to request for an admin account in order to access this section. See Documentation.', 'alert-warning'); - redirect_to('account'); - } - - if ($this->site->inSuperAdminArea() && !$this->user->isSuperAdmin()) { - formr_error(403, 'Forbidden', 'Sorry! Only super admins have access to this section.'); - } - } - - public function createRunUnit($id = null) { - $dbh = $this->fdb; - $run = $this->run; - $unit_factory = new RunUnitFactory(); - $unit_data = array( - 'type' => $this->request->type, - 'position' => (int)$this->request->position, - 'special' => $this->request->special, - ); - $unit_data = array_merge($this->request->getParams(), $unit_data, RunUnit::getDefaults($this->request->type), RunUnit::getDefaults($this->request->special)); - if ($id) { - $unit_data['unit_id'] = $id; - } - $unit = $unit_factory->make($dbh, null, $unit_data, null, $run); - $unit->create($unit_data); - return $unit; - } + public function __construct(Site &$site) { + parent::__construct($site); + $this->header(); + if (!Request::isAjaxRequest()) { + $default_assets = get_default_assets('admin'); + $this->registerAssets($default_assets); + $this->registerAssets('ace'); + } + } + + public function indexAction() { + $this->setView('home', array( + 'runs' => $this->user->getRuns('id DESC', 5), + 'studies' => $this->user->getStudies('id DESC', 5), + )); + return $this->sendResponse(); + } + + public function osfAction() { + if (!($token = OSF::getUserAccessToken($this->user))) { + $this->request->redirect('api/osf/login'); + } + + $osf = new OSF(Config::get('osf')); + $osf->setAccessToken($token); + + if (Request::isHTTPPostRequest() && $this->request->getParam('osf_action') === 'export-run') { + $run = new Run($this->request->getParam('formr_project')); + $osf_project = $this->request->getParam('osf_project'); + if (!$run->valid || !$osf_project) { + throw new Exception('Invalid Request'); + } + + $unitIds = $run->getAllUnitTypes(); + $units = array(); + + /* @var RunUnit $u */ + foreach ($unitIds as $u) { + $unit = RunUnitFactory::make($run, $u); + $ex_unit = $unit->getExportUnit(); + $ex_unit['unit_id'] = $unit->id; + $units[] = (object) $ex_unit; + } + + $export = $run->export($run->name, $units, true); + $export_file = Config::get('survey_upload_dir') . '/run-' . time() . '-' . $run->name . '.json'; + $create = file_put_contents($export_file, json_encode($export, JSON_PRETTY_PRINT + JSON_UNESCAPED_UNICODE + JSON_NUMERIC_CHECK)); + $response = $osf->upload($osf_project, $export_file, $run->name . '-' . date('YmdHis') . '.json'); + @unlink($export_file); + + if (!$response->hasError()) { + $run->saveSettings(array('osf_project_id' => $osf_project)); + alert('Run exported to OSF', 'alert-success'); + } else { + alert($response->getError(), 'alert-danger'); + } + + if ($redirect = $this->request->getParam('redirect')) { + $this->request->redirect($redirect); + } + } + + // @todo implement get projects recursively + $response = $osf->getProjects(); + $osf_projects = array(); + if ($response->hasError()) { + alert($response->getError(), 'alert-danger'); + } else { + foreach ($response->getJSON()->data as $project) { + $osf_projects[] = array('id' => $project->id, 'name' => $project->attributes->title); + } + } + + $this->setView('misc/osf', array( + 'token' => $token, + 'runs' => $this->user->getRuns(), + 'run_selected' => $this->request->getParam('run'), + 'osf_projects' => $osf_projects, + )); + + return $this->sendResponse(); + } + + protected function setView($template, $vars = array()) { + $template = 'admin/' . $template; + parent::setView($template, $vars); + } + + protected function header() { + if (!($cookie = Session::getAdminCookie())) { + alert('You need to login to access the admin section', 'alert-warning'); + $this->request->redirect('login'); + } + + $this->user = new User($cookie[0], $cookie[1]); + + if (!$this->user->isAdmin()) { + $docLink = site_url('documentation/#get_started'); + alert('You need to request for an admin account in order to access this section. See Documentation.', 'alert-warning'); + $this->request->redirect('admin/account'); + } + + if ($this->site->inSuperAdminArea() && !$this->user->isSuperAdmin()) { + formr_error(403, 'Unauthorized', 'You are not authorized to access this section.'); + } + } + + public function createRunUnit($id = null) { + $data = array_merge($this->request->getParams(), RunUnit::getDefaults($this->request->type), RunUnit::getDefaults($this->request->special)); + if ($id) { + $data['id'] = $id; + } + + $unit = RunUnitFactory::make($this->run, $data); + + return $unit->create($data); + } } diff --git a/application/Controller/AdminMailController.php b/application/Controller/AdminMailController.php index 1d38059ef..3634e7645 100644 --- a/application/Controller/AdminMailController.php +++ b/application/Controller/AdminMailController.php @@ -2,77 +2,78 @@ class AdminMailController extends AdminController { - public function __construct(Site &$site) { - parent::__construct($site); - } + public function __construct(Site &$site) { + parent::__construct($site); + } - public function indexAction() { - $vars = array( - 'accs' => $this->user->getEmailAccounts(), - 'form_title' => 'Add Mail Account', - ); - $acc = new EmailAccount($this->fdb, null, $this->user->id); + public function indexAction() { + $vars = array( + 'accs' => $this->user->getEmailAccounts(), + 'form_title' => 'Add Mail Account', + ); + $acc = new EmailAccount(null, $this->user->id); - if ($this->request->account_id) { - $acc = new EmailAccount($this->fdb, $this->request->account_id, $this->user->id); - if (!$acc->valid || !$this->user->created($acc)) { - formr_error(401, 'Unauthorized', 'You do not have access to modify this email account'); - } - $vars['form_title'] = "Edit Mail Account ({$acc->account['username']})"; - } + if ($this->request->account_id) { + $acc = new EmailAccount($this->request->account_id, $this->user->id); + if (!$acc->valid || !$this->user->created($acc)) { + formr_error(401, 'Unauthorized', 'You do not have access to modify this email account'); + } + $vars['form_title'] = "Edit Mail Account ({$acc->account['username']})"; + } - if (Request::isHTTPPostRequest()) { - if ($acc->id && $this->request->account_id == $acc->id) { - // we are editing - $this->edit($acc); - } else { - //we are creating - $this->create($acc); - } - } + if (Request::isHTTPPostRequest()) { + if ($acc->id && $this->request->account_id == $acc->id) { + // we are editing + $this->edit($acc); + } else { + //we are creating + $this->create($acc); + } + } - $vars['acc'] = $acc; - $this->renderView('mail/index', $vars); - } + $vars['acc'] = $acc; + $this->setView('mail/index', $vars); + return $this->sendResponse(); + } - // @todo - public function deleteAction() { - if ($this->request->account_id) { - $acc = new EmailAccount($this->fdb, $this->request->account_id, $this->user->id); - if ($acc->valid && $this->user->created($acc)) { - $email = $acc->account['from']; - $acc->delete(); - alert("Success: Account with email '{$email}' was deleted", 'alert-success'); - } - }; - $this->redirect(); - } + // @todo + public function deleteAction() { + if ($this->request->account_id) { + $acc = new EmailAccount($this->request->account_id, $this->user->id); + if ($acc->valid && $this->user->created($acc)) { + $email = $acc->account['from']; + $acc->delete(); + alert("Success: Account with email '{$email}' was deleted", 'alert-success'); + } + }; + $this->redirect(); + } - protected function create(EmailAccount $acc) { - if ($acc->create()) { - $this->edit($acc); - } else { - alert(implode($acc->errors), 'alert-danger'); - } - } + protected function create(EmailAccount $acc) { + if ($acc->create()) { + $this->edit($acc); + } else { + alert(implode($acc->errors), 'alert-danger'); + } + } - protected function edit(EmailAccount $acc) { - $acc->changeSettings($this->request->getParams()); - alert('Success! Your email account settings were saved!', 'alert-success'); + protected function edit(EmailAccount $acc) { + $acc->changeSettings($this->request->getParams()); + alert('Success! Your email account settings were saved!', 'alert-success'); - if ($this->request->test_account) { - $acc->test(); - } + if ($this->request->test_account) { + $acc->test(); + } - $this->redirect($acc); - } + $this->redirect($acc); + } - protected function redirect(EmailAccount $acc = null) { - if ($acc === null) { - redirect_to('admin/mail'); - } else { - redirect_to('admin/mail', array('account_id' => $acc->id)); - } - } + protected function redirect(EmailAccount $acc = null) { + if ($acc === null) { + $this->request->redirect('admin/mail'); + } else { + $this->request->redirect('admin/mail', array('account_id' => $acc->id)); + } + } } diff --git a/application/Controller/AdminRunController.php b/application/Controller/AdminRunController.php index ffbbb8450..f12dbb3af 100644 --- a/application/Controller/AdminRunController.php +++ b/application/Controller/AdminRunController.php @@ -2,871 +2,727 @@ class AdminRunController extends AdminController { - public function __construct(Site &$site) { - parent::__construct($site); - } - - public function indexAction($run_name = '', $private_action = '') { - $this->setRun($run_name); - if ($private_action) { - if (empty($this->run) || !$this->run->valid) { - throw new Exception("You cannot access this page with no valid run"); - } - - if (strpos($private_action, 'ajax') !== false) { - return AdminAjaxController::call($private_action, $this); - } - - $privateAction = $this->getPrivateAction($private_action); - return $this->$privateAction(); - } - - if (empty($this->run)) { - redirect_to('admin/run/add_run'); - } - - $vars = array( - 'show_panic' => $this->showPanicButton(), - ); - $this->renderView('run/index', $vars); - } - - public function listAction() { - $vars = array( - 'runs' => $this->user->getRuns('id DESC', null), - ); - $this->renderView('run/list', $vars); - } - - public function addRunAction() { - if ($this->request->isHTTPPostRequest()) { - $run_name = $this->request->str('run_name'); - if (!$run_name) { - $error = 'You have to specify a run name'; - } elseif (!preg_match("/^[a-zA-Z][a-zA-Z0-9-]{2,255}$/", $run_name)) { - $error = 'The run name can contain a to Z, 0 to 9 and the hyphen(-) (at least 2 characters, at most 255). It needs to start with a letter.'; - } elseif ($run_name == Run::TEST_RUN || Router::isWebRootDir($run_name) || in_array($run_name, Config::get('reserved_run_names', array())) || Run::nameExists($run_name)) { - $error = __('The run name "%s" is already taken. Please choose another name', $run_name); - } else { - $run = new Run($this->fdb, null); - $run->create(array('run_name' => $run_name, 'user_id' => $this->user->id)); - if ($run->valid) { - alert("Success. Run '{$run->name}' was created.", 'alert-success'); - redirect_to(admin_run_url($run->name)); - } else { - $error = 'An error creating your run please try again'; - } - } - - if (!empty($error)) { - alert("Error: {$error}", 'alert-danger'); - } - } - - $this->renderView('run/add_run'); - } - - private function userOverviewAction() { - $run = $this->run; - $fdb = $this->fdb; - - $search = ''; - $querystring = array(); - $position_cmp = '='; - $query_params = array(':run_id' => $run->id); - - if ($this->request->position_lt && in_array($this->request->position_lt, array('=', '>', '<'))) { - $position_cmp = $this->request->position_lt; - $querystring['position_lt'] = $position_cmp; - } - - if ($this->request->session) { - $session = str_replace("…", "", $this->request->session); - $search .= 'AND `survey_run_sessions`.session LIKE :session '; - $query_params[':session'] = "%" . $session . "%"; - $querystring['session'] = $session; - } - - if ($this->request->position) { - $position = $this->request->position; - $search .= "AND `survey_run_sessions`.position {$position_cmp} :position "; - $query_params[':position'] = $position; - $querystring['position'] = $position; - } - - if ($this->request->sessions) { - $sessions = array(); - foreach (explode("\n", $this->request->sessions) as $session) { - $session = $this->fdb->quote($session); - if($session) { - $sessions[] = $session; - } - } - $search .= " AND session IN (" . implode($sessions, ",") . ")"; - $querystring['sessions'] = $this->request->sessions; - } - - $user_count_query = "SELECT COUNT(`survey_run_sessions`.id) AS count FROM `survey_run_sessions` WHERE `survey_run_sessions`.run_id = :run_id $search;"; - $user_count = $fdb->execute($user_count_query, $query_params, true); - $pagination = new Pagination($user_count, 200, true); - $limits = $pagination->getLimits(); - - $query_params[':admin_code'] = $this->user->user_code; - - $users_query = "SELECT - `survey_run_sessions`.id AS run_session_id, - `survey_run_sessions`.session, - `survey_run_sessions`.position, - `survey_run_units`.description, - `survey_run_sessions`.last_access, - `survey_run_sessions`.created, - `survey_run_sessions`.testing, - `survey_runs`.name AS run_name, - `survey_units`.type AS unit_type, - `survey_run_sessions`.last_access, - (`survey_units`.type IN ('Survey','External','Email') AND DATEDIFF(NOW(), `survey_run_sessions`.last_access) >= 2) AS hang - FROM `survey_run_sessions` - LEFT JOIN `survey_runs` ON `survey_run_sessions`.run_id = `survey_runs`.id - LEFT JOIN `survey_run_units` ON `survey_run_sessions`.position = `survey_run_units`.position AND `survey_run_units`.run_id = `survey_run_sessions`.run_id - LEFT JOIN `survey_units` ON `survey_run_units`.unit_id = `survey_units`.id - WHERE `survey_run_sessions`.run_id = :run_id $search - ORDER BY `survey_run_sessions`.session != :admin_code, hang DESC, `survey_run_sessions`.last_access DESC - LIMIT $limits;"; - - $vars = get_defined_vars(); - $vars['users'] = $fdb->execute($users_query, $query_params); - $vars['position_lt'] = $position_cmp; - $vars['currentUser'] = $this->user; - $vars['unit_types'] = $run->getAllUnitTypes(); - $vars['reminders'] = $this->run->getSpecialUnits(false, 'ReminderEmail'); - $this->renderView('run/user_overview', $vars); - } - - private function exportUserOverviewAction() { - $users_query = "SELECT - `survey_run_sessions`.position, - `survey_units`.type AS unit_type, - `survey_run_units`.description, - `survey_run_sessions`.session, - `survey_run_sessions`.created, - `survey_run_sessions`.last_access, - (`survey_units`.type IN ('Survey','External','Email') AND DATEDIFF(NOW(), `survey_run_sessions`.last_access) >= 2) AS hang - FROM `survey_run_sessions` - LEFT JOIN `survey_runs` ON `survey_run_sessions`.run_id = `survey_runs`.id - LEFT JOIN `survey_run_units` ON `survey_run_sessions`.position = `survey_run_units`.position AND `survey_run_units`.run_id = `survey_run_sessions`.run_id - LEFT JOIN `survey_units` ON `survey_run_units`.unit_id = `survey_units`.id - WHERE `survey_run_sessions`.run_id = :run_id ORDER BY `survey_run_sessions`.session != :admin_code, hang DESC, `survey_run_sessions`.last_access DESC"; - - $query_params = array(':run_id' => $this->run->id, ':admin_code' => $this->user->user_code); - $query_obj = $this->fdb->prepare($users_query); - $query_obj->execute($query_params); - - $SPR = new SpreadsheetReader(); - $download_successfull = $SPR->exportInRequestedFormat($query_obj , $this->run->name . '_user_overview', $this->request->str('format')); - if (!$download_successfull) { - alert('An error occured during user overview download.', 'alert-danger'); - redirect_to(admin_run_url($this->run->name, 'user_overview')); + public function __construct(Site &$site) { + parent::__construct($site); + } + + public function indexAction($run_name = '', $private_action = '') { + $this->setRun($run_name); + if ($private_action) { + if (empty($this->run) || !$this->run->valid) { + throw new Exception("You cannot access this page with no valid run"); + } + + if (strpos($private_action, 'ajax') !== false) { + $this->response = AdminAjaxController::call($private_action, $this); + return $this->sendResponse(); + } + + $privateAction = $this->getPrivateAction($private_action); + return $this->$privateAction(); + } + + if (empty($this->run)) { + $this->request->redirect('admin/run/add_run'); + } + + $vars = array( + 'show_panic' => $this->showPanicButton(), + 'add_unit_buttons' => $this->getUnitAddButtons(), + ); + + $this->setView('run/index', $vars); + return $this->sendResponse(); + } + + public function listAction() { + $vars = array( + 'runs' => $this->user->getRuns('id DESC', null), + ); + + $this->setView('run/list', $vars); + return $this->sendResponse(); + } + + public function addRunAction() { + if ($this->request->isHTTPPostRequest()) { + $run_name = $this->request->str('run_name'); + if (!$run_name) { + $error = 'You have to specify a run name'; + } elseif (!preg_match("/^[a-zA-Z][a-zA-Z0-9-]{2,255}$/", $run_name)) { + $error = 'The run name can contain a to Z, 0 to 9 and the hyphen(-) (at least 2 characters, at most 255). It needs to start with a letter.'; + } elseif ($run_name == Run::TEST_RUN || Router::isWebRootDir($run_name) || in_array($run_name, Config::get('reserved_run_names', array())) || Run::nameExists($run_name)) { + $error = __('The run name "%s" is already taken. Please choose another name', $run_name); + } else { + $run = new Run(); + $run->create([ + 'run_name' => $run_name, + 'user_id' => $this->user->id + ]); + if ($run->valid) { + alert("Success. Run '{$run->name}' was created.", 'alert-success'); + $this->request->redirect(admin_run_url($run->name)); + } else { + $error = 'An error creating your run please try again'; } - } - - private function exportUserDetailAction() { - $users_query = "SELECT - `survey_run_units`.position, - `survey_units`.type AS unit_type, - `survey_run_units`.description, - `survey_run_sessions`.session, - `survey_unit_sessions`.created AS entered, - IF (`survey_unit_sessions`.ended > 0, UNIX_TIMESTAMP(`survey_unit_sessions`.ended)-UNIX_TIMESTAMP(`survey_unit_sessions`.created), - UNIX_TIMESTAMP(NOW())-UNIX_TIMESTAMP(`survey_unit_sessions`.created)) AS 'seconds_stayed', - `survey_unit_sessions`.ended AS 'left', - `survey_unit_sessions`.expired - FROM `survey_unit_sessions` - LEFT JOIN `survey_run_sessions` ON `survey_run_sessions`.id = `survey_unit_sessions`.run_session_id - LEFT JOIN `survey_units` ON `survey_unit_sessions`.unit_id = `survey_units`.id - LEFT JOIN `survey_run_units` ON `survey_unit_sessions`.unit_id = `survey_run_units`.unit_id - LEFT JOIN `survey_runs` ON `survey_runs`.id = `survey_run_units`.run_id - WHERE `survey_runs`.id = :run_id - AND `survey_run_sessions`.run_id = :run_id2 - ORDER BY `survey_run_sessions`.id DESC,`survey_unit_sessions`.id ASC;"; - - $query_params = array(':run_id' => $this->run->id, ':run_id2' => $this->run->id); - $query_obj = $this->fdb->prepare($users_query); - $query_obj->execute($query_params); - - $SPR = new SpreadsheetReader(); - $download_successfull = $SPR->exportInRequestedFormat($query_obj , $this->run->name . '_user_detail', $this->request->str('format')); - if (!$download_successfull) { - alert('An error occured during user detail download.', 'alert-danger'); - redirect_to(admin_run_url($this->run->name, 'user_detail')); + } + + if (!empty($error)) { + alert("Error: {$error}", 'alert-danger'); + } + } + + $this->setView('run/add_run'); + return $this->sendResponse(); + } + + private function userOverviewAction() { + $run = $this->run; + $fdb = $this->fdb; + $querystring = array(); + $queryparams = array('run_id' => $run->id, 'position_operator' => '='); + + if ($this->request->position_lt && in_array($this->request->position_lt, array('=', '>', '<'))) { + $queryparams['position_operator'] = $this->request->position_lt; + $querystring['position_lt'] = $queryparams['position_operator']; + } + + if ($this->request->session) { + $session = str_replace("…", "", $this->request->session); + $queryparams['session'] = "%" . $session . "%"; + $querystring['session'] = $session; + } + + if ($this->request->position) { + $queryparams['position'] = $this->request->position; + $querystring['position'] = $queryparams['position']; + } + + if ($this->request->sessions) { + $sessions = array(); + foreach (explode("\n", $this->request->sessions) as $session) { + $session = $this->fdb->quote($session); + if ($session) { + $sessions[] = $session; } - } - - private function createNewTestCodeAction() { - $run_session = $this->run->makeTestRunSession(); - $sess = $run_session->session; - $animal = substr($sess, 0,strpos($sess, "XXX")); - $sess_url = run_url($this->run->name, null, array('code' => $sess)); - - //alert("You've created a new guinea pig, ".h($animal).". Use this guinea pig to move through the run like a normal user with special powers (accessibly via the monkey bar at the bottom right). As a guinea pig, you can see more detailed error messages than real users, so it is easier to e.g. debug R problems. If you want someone else to be the guinea pig, just forward them this link:
", "alert-info"); - redirect_to($sess_url); - } - - private function createNewNamedSessionAction() { - - if(Request::isHTTPPostRequest()) { - $code_name = $this->request->getParam('code_name'); - $run_session = $this->run->addNamedRunSession($code_name); - - if($run_session) { - $sess = $run_session->session; - $sess_url = run_url($this->run->name, null, array('code' => $sess)); - - //alert("You've added a user with the code name '{$code_name}'.
Send them this link to participate
", "alert-info"); - redirect_to(admin_run_url($this->run->name, 'user_overview', array('session' => $sess))); - } - } - - $this->renderView('run/create_new_named_session'); - - } - - private function userDetailAction() { - $run = $this->run; - $fdb = $this->fdb; - - $search = ''; - $querystring = array(); - $position_lt = '='; - if ($this->request->session) { - $session = str_replace('…', '', $this->request->session); - $search .= 'AND `survey_run_sessions`.session LIKE :session '; - $search_session = "%" . $session . "%"; - $querystring['session'] = $session; - } - - if ($this->request->position) { - $position = $this->request->position; - if (in_array($this->request->position_lt, array('>', '=', '<'))) { - $position_lt = $this->request->position_lt; - } - $search .= 'AND `survey_run_units`.position '.$position_lt.' :position '; - $search_position = $position; - $querystring['position_lt'] = $position_lt; - $querystring['position'] = $position; - } - - $user_count_query = " - SELECT COUNT(`survey_unit_sessions`.id) AS count FROM `survey_unit_sessions` - LEFT JOIN `survey_run_sessions` ON `survey_run_sessions`.id = `survey_unit_sessions`.run_session_id - LEFT JOIN `survey_run_units` ON `survey_unit_sessions`.`unit_id` = `survey_run_units`.`unit_id` - WHERE `survey_run_sessions`.run_id = :run_id $search"; - - $params = array(':run_id' => $run->id); - if (isset($search_session)) { - $params[':session'] = $search_session; - } - if (isset($search_position)) { - $params[':position'] = $search_position; - } - - $user_count = $fdb->execute($user_count_query, $params, true); - $pagination = new Pagination($user_count, 400, true); - $limits = $pagination->getLimits(); - - - $params[':run_id2'] = $params[':run_id']; - - $users_query = "SELECT - `survey_run_sessions`.session, - `survey_unit_sessions`.id AS session_id, - `survey_runs`.name AS run_name, - `survey_run_units`.position, - `survey_run_units`.description, - `survey_units`.type AS unit_type, - `survey_unit_sessions`.created, - `survey_unit_sessions`.ended, - `survey_unit_sessions`.expired - FROM `survey_unit_sessions` - LEFT JOIN `survey_run_sessions` ON `survey_run_sessions`.id = `survey_unit_sessions`.run_session_id - LEFT JOIN `survey_units` ON `survey_unit_sessions`.unit_id = `survey_units`.id - LEFT JOIN `survey_run_units` ON `survey_unit_sessions`.unit_id = `survey_run_units`.unit_id - LEFT JOIN `survey_runs` ON `survey_runs`.id = `survey_run_units`.run_id - WHERE `survey_runs`.id = :run_id2 AND `survey_run_sessions`.run_id = :run_id $search - ORDER BY `survey_run_sessions`.id DESC,`survey_unit_sessions`.id ASC LIMIT $limits"; - - $users = $fdb->execute($users_query, $params); - - foreach ($users as $i => $userx) { - if ($userx['expired']) { - $stay_seconds = strtotime($userx['expired']) - strtotime($userx['created']); - } else { - $stay_seconds = ($userx['ended'] ? strtotime($userx['ended']) : time() ) - strtotime($userx['created']); - } - $userx['stay_seconds'] = $stay_seconds; - if($userx['expired']) { - $userx['ended'] = $userx['expired'] . ' (expired)'; - } - - if($userx['unit_type'] != 'Survey') { - $userx['delete_msg'] = "Are you sure you want to delete this unit session?"; - $userx['delete_title'] = "Delete this waypoint"; - } else { - $userx['delete_msg'] = "You SHOULDN'T delete survey sessions, you might delete data!
Are you REALLY sure you want to continue?"; - $userx['delete_title'] = "Survey unit sessions should not be deleted"; - } - - $users[$i] = $userx; - } - - $vars = get_defined_vars(); - $this->renderView('run/user_detail', $vars); - } - - private function uploadFilesAction() { - $run = $this->run; - - if (!empty($_FILES['uploaded_files'])) { - if($run->uploadFiles($_FILES['uploaded_files'])) { - alert('Success. The files were uploaded.','alert-success'); - if(!empty($run->messages)) { - alert(implode($run->messages, ' '), 'alert-info'); - } - redirect_to(admin_run_url($run->name, 'upload_files')); - } else { - alert('Sorry, files could not be uploaded.
' . nl2br(implode($run->errors, "\n")),'alert-danger'); - } - } elseif ($this->request->isHTTPPostRequest()) { - alert('The size of your request exceeds the allowed limit. Please report this to administrators indicating the size of your files.', 'alert-danger'); - } - - $this->renderView('run/upload_files', array('files' => $run->getUploadedFiles())); - } - - private function deleteFileAction() { - $id = $this->request->int('id'); - $filename = $this->request->str('file'); - $deleted = $this->run->deleteFile($id, $filename); - if ($deleted) { - alert('File Deleted', 'alert-success'); - } else { - alert('Unable to delete selected file', 'alert-danger'); - } - redirect_to(admin_run_url($this->run->name, 'upload_files')); - } - - private function settingsAction() { - $osf_projects = array(); - - if (($token = OSF::getUserAccessToken($this->user))) { - $osf = new OSF(Config::get('osf')); - $osf->setAccessToken($token); - $response = $osf->getProjects(); - - if ($response->hasError()) { - alert($response->getError(), 'alert-danger'); - $token = null; - } else { - foreach ($response->getJSON()->data as $project) { - $osf_projects[] = array('id' => $project->id, 'name' => $project->attributes->title); - } - } - } - - $this->renderView('run/settings', array( - 'osf_token' => $token, - 'run_selected'=> $this->request->getParam('run'), - 'osf_projects' => $osf_projects, - 'osf_project' => $this->run->osf_project_id, - 'run_id' => $this->run->id, - 'reminders' => $this->run->getSpecialUnits(true, 'ReminderEmail'), - 'service_messages' => $this->run->getSpecialUnits(true, 'ServiceMessagePage'), - 'overview_scripts' => $this->run->getSpecialUnits(true, 'OverviewScriptPage'), - )); - } - - private function renameRunAction() { - $run = $this->run; - if($this->request->isHTTPPostRequest()) { - $run_name = $this->request->str('new_name'); - if (!$run_name) { - $error = 'You have to specify a new run name'; - } elseif (!preg_match("/^[a-zA-Z][a-zA-Z0-9-]{2,255}$/", $run_name)) { - $error = 'The run name can contain a to Z, 0 to 9 and the hyphen(-) (at least 2 characters, at most 255). It needs to start with a letter.'; - } elseif ($run_name == Run::TEST_RUN || Router::isWebRootDir($run_name) || in_array($run_name, Config::get('reserved_run_names', array())) || Run::nameExists($run_name)) { - $error = __('The run name "%s" is already taken. Please choose another name', $run_name); - } else { - if ($run->rename($run_name)) { - alert("Success. Run was renamed to '{$run_name}'.", 'alert-success'); - redirect_to(admin_run_url($run_name)); - } else { - $error = 'An error renaming your run please try again'; - } - } - - if (!empty($error)) { - alert("Error: {$error}", 'alert-danger'); - } - } - - $this->renderView('run/rename_run'); - } - - private function exportDataAction() { - $run = $this->run; - $format = $this->request->str('format'); - $SPR = new SpreadsheetReader(); - SpreadsheetReader::verifyExportFormat($format); - - /* @var $resultsStmt PDOStatement */ - $resultsStmt = $run->getData(true); - if (!$resultsStmt->columnCount()) { - alert('No linked data yet', 'alert-info'); - redirect_to(admin_run_url($run->name)); - } - - $filename = $run->name . '_data'; - switch ($format) { - case 'xlsx': - $downloaded = $SPR->exportXLSX($resultsStmt, $filename); - break; - case 'xls': - $downloaded = $SPR->exportXLS($resultsStmt, $filename); - break; - case 'csv_german': - $downloaded = $SPR->exportCSV_german($resultsStmt, $filename); - break; - case 'tsv': - $downloaded = $SPR->exportTSV($resultsStmt, $filename); - break; - case 'json': - $downloaded = $SPR->exportJSON($resultsStmt, $filename); - break; - default: - $downloaded = $SPR->exportCSV($resultsStmt, $filename); - break; - } - - if (!$downloaded) { - alert('An error occured during results download.', 'alert-danger'); - redirect_to(admin_run_url($run->name)); - } - } - - private function exportSurveyResultsAction() { - $studies = $this->run->getAllSurveys(); - $dir = APPLICATION_ROOT . 'tmp/backups/results'; - if (!$dir) { - alert('Unable to create run backup directory', 'alert-danger'); - redirect_to(admin_run_url($this->run->name)); - } - - // create study result files - $SPR = new SpreadsheetReader(); - $errors = $files = $metadata = array(); - $metadata['run'] = array( - 'ID' => $this->run->id, - 'NAME' => $this->run->name, - ); - - foreach ($studies as $study) { - $survey = Survey::loadById($study['id']); - $backupFile = $dir . '/' . $this->run->name . '-' . $survey->name . '.tab'; - $backup = $SPR->exportTSV($survey->getResults(null, null, null, $this->run->id, true), $survey->name, $backupFile); - if (!$backup) { - $errors[] = "Unable to backup {$survey->name}"; - } else { - $files[] = $backupFile; - } - $metadata['survey:'.$survey->id] = array( - 'ID' => $survey->id, - 'NAME' => $survey->name, - 'RUN_ID' => $this->run->id - ); - } - - $metafile = $dir . '/' . $this->run->name . '.metadata'; - if (create_ini_file($metadata, $metafile)) { - $files[] = $metafile; - } - - // zip files and send to - if ($files) { - $zipfile = $dir . '/' . $this->run->name . '-' . date('d-m-Y') . '.zip'; - - //create the archive - if (!create_zip_archive($files, $zipfile)) { - alert('Unable to create zip archive: ' . basename($zipfile), 'alert-danger'); - redirect_to(admin_run_url($this->run->name)); - } - - $filename = basename($zipfile); - header("Content-Type: application/zip"); - header("Content-Disposition: attachment; filename=$filename"); - header("Content-Length: " . filesize($zipfile)); - readfile($zipfile); - // attempt to cleanup files after download - $files[] = $zipfile; - deletefiles($files); - exit; - } else { - alert('No files to zip and download', 'alert-danger'); - } - redirect_to(admin_run_url($this->run->name)); - } - - private function randomGroupsExportAction() { - $run = $this->run; - $format = $this->request->str('format'); - $SPR = new SpreadsheetReader(); - SpreadsheetReader::verifyExportFormat($format); - - /* @var $resultsStmt PDOStatement */ - $resultsStmt = $run->getRandomGroups(); //@TODO unset run_name, unit_type, ended, position - if (!$resultsStmt->columnCount()) { - alert('No linked data yet', 'alert-info'); - redirect_to(admin_run_url($run->name)); - } - - $filename = "Shuffle_Run_" . $run->name; - switch ($format) { - case 'xlsx': - $downloaded = $SPR->exportXLSX($resultsStmt, $filename); - break; - case 'xls': - $downloaded = $SPR->exportXLS($resultsStmt, $filename); - break; - case 'csv_german': - $downloaded = $SPR->exportCSV_german($resultsStmt, $filename); - break; - case 'tsv': - $downloaded = $SPR->exportTSV($resultsStmt, $filename); - break; - case 'json': - $downloaded = $SPR->exportJSON($resultsStmt, $filename); - break; - default: - $downloaded = $SPR->exportCSV($resultsStmt, $filename); - break; - } - - if (!$downloaded) { - alert('An error occured during results download.', 'alert-danger'); - redirect_to(admin_run_url($run->name)); - } - } - - private function randomGroupsAction() { - $run = $this->run; - $g_users = $run->getRandomGroups(); - - $users = array(); - while($userx = $g_users->fetch(PDO::FETCH_ASSOC)) { - $userx['Unit in Run'] = $userx['unit_type']. " ({$userx['position']})"; - # $userx['Email'] = "{$userx['email']}"; - $userx['Group'] = "{$userx['group']}"; - $userx['Created'] = "{$userx['created']}"; - - unset($userx['run_name']); - unset($userx['unit_type']); - unset($userx['created']); - unset($userx['ended']); - unset($userx['position']); - unset($userx['email']); - unset($userx['group']); - # $user['body'] = "". substr($user['body'],0,50). "…"; - - $users[] = $userx; - } - $this->renderView('run/random_groups', array('users' => $users)); - } - - private function overviewAction() { - $run = $this->run; - - $this->renderView('run/overview', array( - 'users' => $run->getNumberOfSessionsInRun(), - 'overview_script' => $run->getOverviewScript(), - 'user_overview' => $run->getUserCounts(), - )); - } - - private function emptyRunAction() { - $run = $this->run; - if ($this->request->isHTTPPostRequest()) { - if ($this->request->getParam('empty_confirm') === $run->name) { - $run->emptySelf(); - redirect_to(admin_run_url($run->name, "empty_run")); - } else { - alert("Error: You must type the run's name '{$run->name}' to empty it.", 'alert-danger'); - } - } - - $this->renderView('run/empty_run', array( - 'users' => $run->getNumberOfSessionsInRun(), - )); - - } - - private function emailLogAction() { - $run = $this->run; - $fdb = $this->fdb; - - $email_count_query = "SELECT COUNT(`survey_email_log`.id) AS count - FROM `survey_email_log` - LEFT JOIN `survey_unit_sessions` ON `survey_unit_sessions`.id = `survey_email_log`.session_id - LEFT JOIN `survey_run_sessions` ON `survey_unit_sessions`.run_session_id = `survey_run_sessions`.id - WHERE `survey_run_sessions`.run_id = :run_id"; - - $email_count = $fdb->execute($email_count_query, array(':run_id' => $run->id), true); - $pagination = new Pagination($email_count, 50, true); - $limits = $pagination->getLimits(); - - $emails_query = "SELECT - `survey_email_accounts`.from_name, - `survey_email_accounts`.`from`, - `survey_email_log`.recipient AS `to`, - `survey_email_log`.`sent`, - `survey_emails`.subject, - `survey_emails`.body, - `survey_email_log`.created, - `survey_run_units`.position AS position_in_run - FROM `survey_email_log` - LEFT JOIN `survey_emails` ON `survey_email_log`.email_id = `survey_emails`.id - LEFT JOIN `survey_run_units` ON `survey_emails`.id = `survey_run_units`.unit_id - LEFT JOIN `survey_email_accounts` ON `survey_emails`.account_id = `survey_email_accounts`.id - LEFT JOIN `survey_unit_sessions` ON `survey_unit_sessions`.id = `survey_email_log`.session_id - LEFT JOIN `survey_run_sessions` ON `survey_unit_sessions`.run_session_id = `survey_run_sessions`.id - WHERE `survey_run_sessions`.run_id = :run_id - ORDER BY `survey_email_log`.id DESC LIMIT $limits ;"; - - $g_emails = $fdb->execute($emails_query, array(':run_id' => $run->id)); - $emails = array(); - foreach ($g_emails as $email) { - $email['from'] = "{$email['from_name']}
{$email['from']}"; - unset($email['from_name']); - $email['to'] = $email['to']."
at run position ".$email['position_in_run'].""; - $email['mail'] = $email['subject']."
". h(substr($email['body'], 0, 100)). "…"; - $email['datetime'] = ''.timetostr(strtotime($email['created'])).' '; - $email['datetime'] .= $email['sent'] ? '' : ''; - unset($email['position_in_run'], $email['subject'], $email['body'], $email['created'], $email['sent']); - $emails[] = $email; - } - - $vars = get_defined_vars(); - $this->renderView('run/email_log', $vars); - } - - private function deleteRunAction() { - $run = $this->run; - if(isset($_POST['delete']) AND trim($_POST['delete_confirm']) === $run->name) { - $run->delete(); - } elseif(isset($_POST['delete'])) { - alert("Error: You must type the run's name '{$run->name}' to delete it.",'alert-danger'); - } - - $this->renderView('run/delete_run', array( - 'users' => $run->getNumberOfSessionsInRun(), - )); - } - - private function cronLogParsed() { - $parser = new LogParser(); - $parse = $this->run->name . '.log'; - $vars = get_defined_vars(); - $this->renderView('run/cron_log_parsed', $vars); - } - - private function cronLogAction() { - return $this->cronLogParsed(); - // @todo: deprecate code - $run = $this->run; - $fdb = $this->fdb; - - $fdb->count('survey_cron_log', array('run_id' => $run->id)); - $cron_entries_count = $fdb->count('survey_cron_log', array('run_id' => $run->id)); - - $pagination = new Pagination($cron_entries_count); - $limits = $pagination->getLimits(); - - $cron_query = "SELECT - `survey_cron_log`.id, - `survey_cron_log`.run_id, - `survey_cron_log`.created, - `survey_cron_log`.ended - `survey_cron_log`.created AS time_in_seconds, - `survey_cron_log`.sessions, - `survey_cron_log`.skipbackwards, - `survey_cron_log`.skipforwards, - `survey_cron_log`.pauses, - `survey_cron_log`.emails, - `survey_cron_log`.shuffles, - `survey_cron_log`.errors, - `survey_cron_log`.warnings, - `survey_cron_log`.notices, - `survey_cron_log`.message - FROM `survey_cron_log` - WHERE `survey_cron_log`.run_id = :run_id - ORDER BY `survey_cron_log`.id DESC LIMIT $limits;"; - - $g_cron = $fdb->execute($cron_query, array(':run_id' => $run->id)); - - $cronlogs = array(); - foreach ($g_cron as $cronlog) { - $cronlog = array_reverse($cronlog, true); - $cronlog['Modules'] = ''; - - if($cronlog['pauses']>0) - $cronlog['Modules'] .= $cronlog['pauses'].' '; - if($cronlog['skipbackwards']>0) - $cronlog['Modules'] .= $cronlog['skipbackwards'].' '; - if($cronlog['skipforwards']>0) - $cronlog['Modules'] .= $cronlog['skipforwards'].' '; - if($cronlog['emails']>0) - $cronlog['Modules'] .= $cronlog['emails'].' '; - if($cronlog['shuffles']>0) - $cronlog['Modules'] .= $cronlog['shuffles'].' '; - $cronlog['Modules'] .= ''; - $cronlog['took'] = ''.round($cronlog['time_in_seconds']/60, 2). 'm'; - $cronlog['time'] = ''.timetostr(strtotime($cronlog['created'])). ''; - $cronlog = array_reverse($cronlog, true); - unset($cronlog['created']); - unset($cronlog['time_in_seconds']); - unset($cronlog['skipforwards']); - unset($cronlog['skipbackwards']); - unset($cronlog['pauses']); - unset($cronlog['emails']); - unset($cronlog['shuffles']); - unset($cronlog['run_id']); - unset($cronlog['id']); - - $cronlogs[] = $cronlog; - } - - $vars = get_defined_vars(); - $this->renderView('run/cron_log', $vars); - } - - private function setRun($name) { - if (!$name) { - return; - } - - $run = new Run($this->fdb, $name); - if (!$run->valid) { - formr_error(404, 'Not Found', 'Requested Run does not exist or has been moved'); - } elseif (!$this->user->created($run)) { - formr_error(401, 'Unauthorized', 'You do not have access to modify this run'); - } - $this->run = $run; - } - - private function exportAction() { - $formats = array('json'); - $run = $this->run; - $site = $this->site; - - if (($units = (array)json_decode($site->request->str('units'))) && ($name = $site->request->str('export_name')) && preg_match('/^[a-z0-9-\s]+$/i', $name)) { - $format = $this->request->getParam('format'); - $inc_survey = $this->request->getParam('include_survey_details') === 'true'; - if (!in_array($format, $formats)) { - alert('Invalid Export format selected', 'alert-danger'); - redirect_to(admin_run_url($run->name)); - } - - if (!($export = $run->export($name, $units, $inc_survey))) { - bad_request_header(); - echo $site->renderAlerts(); - } else { - $SPR = new SpreadsheetReader(); - $SPR->exportJSON($export, $name); - } - } else { - alert('Run Export: Missing run units or invalid run name enterd.', 'alert-danger'); - redirect_to(admin_run_url($run->name)); - } - } - - private function importAction() { - if ($run_file = $this->request->getParam('run_file_name')) { - $file = Config::get('run_exports_dir') . '/' . $run_file; - } elseif (!empty($_FILES['run_file'])) { - $file = $_FILES['run_file']['tmp_name']; - } - - if (empty($file)) { - alert('Please select a run file or upload one', 'alert-danger'); - return redirect_to(admin_run_url($this->run->name)); - } - - if (!file_exists($file)) { - alert('The corresponding import file could not be found or is not readable', 'alert-danger'); - return redirect_to(admin_run_url($this->run->name)); - } - - $json_string = file_get_contents($file); - if (!$json_string) { - alert('Unable to extract JSON object from file', 'alert-danger'); - return redirect_to(admin_run_url($this->run->name)); - } - - $start_position = 10; - if ($this->run->importUnits($json_string, $start_position)) { - alert('Run modules imported successfully!', 'alert-success'); - } - - redirect_to(admin_run_url($this->run->name)); - } - - private function createRunUnitAction() { - $redirect = $this->request->redirect ? admin_run_url($this->run->name, $this->request->redirect) : admin_run_url($this->run->name); - $unit = $this->createRunUnit(); - if ($unit->valid) { - $unit->addToRun($this->run->id, $unit->position); - alert('Run unit created', 'alert-success'); - } else { - alert('An unexpected error occured. Unit could not be created', 'alert-danger'); - } - redirect_to(str_replace(':::', '#', $redirect)); - } - - private function deleteRunUnitAction() { - $id = (int)$this->request->unit_id; - if (!$id) { - throw new Exception('Missing Parameter'); - } - $redirect = $this->request->redirect ? admin_run_url($this->run->name, $this->request->redirect) : admin_run_url($this->run->name); - $unit = $this->createRunUnit($id); - if ($unit->valid) { - $unit->run_unit_id = $id; - $unit->removeFromRun($this->request->special); - alert('Run unit deleted', 'alert-success'); - } else { - alert('An unexpected error occured. Unit could not be deleted', 'alert-danger'); - } - redirect_to(str_replace(':::', '#', $redirect)); - } - - private function panicAction() { - $settings = array( - 'locked' => 1, - 'cron_active' => 0, - 'public' => 0, - //@todo maybe do more - ); - $updated = $this->fdb->update('survey_runs', $settings, array('id' => $this->run->id)); - if ($updated) { - $msg = array("Panic mode activated for '{$this->run->name}'"); - $msg[] = " - Only you can access this run"; - $msg[] = " - The cron job for this run has been deactivated"; - $msg[] = " - The run has been 'locked' for editing"; - alert(implode("\n", $msg), 'alert-success'); - } - redirect_to("admin/run/{$this->run->name}"); - } - - private function showPanicButton() { - $on = $this->run->locked === 1 && - $this->run->cron_active === 0 && - $this->run->public === 0; - return !$on; - } + } + $queryparams['sessions'] = $sessions; + $querystring['sessions'] = $this->request->sessions; + } + + $queryparams['admin_code'] = $this->user->user_code; + $helper = new RunHelper($run, $fdb, $this->request); + $table = $helper->getUserOverviewTable($queryparams); + + $this->setView('run/user_overview', array( + 'users' => $table['data'], + 'pagination' => $table['pagination'], + 'position_lt' => $queryparams['position_operator'], + 'currentUser' => $this->user, + 'unit_types' => $run->getAllUnitTypes(), + 'reminders' => $this->run->getSpecialUnits(false, 'ReminderEmail'), + 'querystring' => $querystring, + )); + + return $this->sendResponse(); + } + + private function exportUserOverviewAction() { + $helper = new RunHelper($this->run, $this->fdb, $this->request); + $queryParams = array('run_id' => $this->run->id, 'admin_code' => $this->user->user_code); + $exportStmt = $helper->getUserOverviewExportPdoStatement($queryParams); + $SPR = new SpreadsheetReader(); + $download_successfull = $SPR->exportInRequestedFormat($exportStmt, $this->run->name . '_user_overview', $this->request->str('format')); + if (!$download_successfull) { + alert('An error occured during user overview download.', 'alert-danger'); + $this->request->redirect(admin_run_url($this->run->name, 'user_overview')); + } + } + + private function userDetailAction() { + $run = $this->run; + $fdb = $this->fdb; + $querystring = array(); + $queryparams = array('run_id' => $run->id, 'position_operator' => '='); + + if ($this->request->position_lt && in_array($this->request->position_lt, array('=', '>', '<'))) { + $queryparams['position_operator'] = $this->request->position_lt; + $querystring['position_lt'] = $queryparams['position_operator']; + } + + if ($this->request->session) { + $session = str_replace("…", "", $this->request->session); + $queryparams['session'] = "%" . $session . "%"; + $querystring['session'] = $session; + } + + if ($this->request->position) { + $queryparams['position'] = $this->request->position; + $querystring['position'] = $queryparams['position']; + } + + $helper = new RunHelper($run, $fdb, $this->request); + $table = $helper->getUserDetailTable($queryparams); + $users = $table['data']; + + foreach ($users as $i => $userx) { + if ($userx['expired']) { + $stay_seconds = strtotime($userx['expired']) - strtotime($userx['created']); + } else { + $stay_seconds = ($userx['ended'] ? strtotime($userx['ended']) : time() ) - strtotime($userx['created']); + } + $userx['stay_seconds'] = $stay_seconds; + if ($userx['expired']) { + $userx['ended'] = $userx['expired'] . ' (expired)'; + } + + if ($userx['unit_type'] != 'Survey') { + $userx['delete_msg'] = "Are you sure you want to delete this unit session?"; + $userx['delete_title'] = "Delete this waypoint"; + } else { + $userx['delete_msg'] = "You SHOULDN'T delete survey sessions, you might delete data!
Are you REALLY sure you want to continue?"; + $userx['delete_title'] = "Survey unit sessions should not be deleted"; + } + + $users[$i] = $userx; + } + + $this->setView('run/user_detail', array( + 'users' => $users, + 'pagination' => $table['pagination'], + 'position_lt' => $queryparams['position_operator'], + 'querystring' => $querystring, + )); + + return $this->sendResponse(); + } + + private function exportUserDetailAction() { + $helper = new RunHelper($this->run, $this->fdb, $this->request); + $queryParams = array(':run_id' => $this->run->id, ':run_id2' => $this->run->id); + $exportStmt = $helper->getUserDetailExportPdoStatement($queryParams); + $SPR = new SpreadsheetReader(); + $download_successfull = $SPR->exportInRequestedFormat($exportStmt, $this->run->name . '_user_detail', $this->request->str('format')); + if (!$download_successfull) { + alert('An error occured during user detail download.', 'alert-danger'); + $this->request->redirect(admin_run_url($this->run->name, 'user_detail')); + } + } + + private function createNewTestCodeAction() { + $run_session = RunSession::getTestSession($this->run); + $sess = $run_session->session; + $animal = substr($sess, 0, strpos($sess, "XXX")); + $sess_url = run_url($this->run->name, null, array('code' => $sess)); + + if (Config::get('use_study_subdomains')) { + $this->request->redirect($sess_url); + } else { + alert("You've created a new guinea pig, ".h($animal).". Use this guinea pig to move through the run like a normal user with special powers (accessibly via the monkey bar at the bottom right). As a guinea pig, you can see more detailed error messages than real users, so it is easier to e.g. debug R problems. If you want someone else to be the guinea pig, just forward them this link:
", "alert-info"); + $this->request->redirect(admin_run_url($this->run->name, 'user_overview')); + } + } + + private function createNewNamedSessionAction() { + if (Request::isHTTPPostRequest()) { + $code_name = $this->request->getParam('code_name'); + $run_session = RunSession::getNamedSession($this->run, $code_name); + + if ($run_session) { + $sess = $run_session->session; + $sess_url = run_url($this->run->name, null, array('code' => $sess)); + + //alert("You've added a user with the code name '{$code_name}'.
Send them this link to participate
", "alert-info"); + $this->request->redirect(admin_run_url($this->run->name, 'user_overview', array('session' => $sess))); + } + } + + $this->setView('run/create_new_named_session'); + return $this->sendResponse(); + } + + private function uploadFilesAction() { + $run = $this->run; + + if (!empty($_FILES['uploaded_files'])) { + if ($run->uploadFiles($_FILES['uploaded_files'])) { + alert('Success. The files were uploaded.', 'alert-success'); + if (!empty($run->messages)) { + alert(implode(' ', $run->messages), 'alert-info'); + } + $this->request->redirect(admin_run_url($run->name, 'upload_files')); + } else { + alert('Sorry, files could not be uploaded.
' . nl2br(implode("\n", $run->errors)), 'alert-danger'); + } + } elseif ($this->request->isHTTPPostRequest()) { + alert('The size of your request exceeds the allowed limit. Please report this to administrators indicating the size of your files.', 'alert-danger'); + } + + $this->setView('run/upload_files', array('files' => $run->getUploadedFiles())); + return $this->sendResponse(); + } + + private function deleteFileAction() { + $id = $this->request->int('id'); + $filename = $this->request->str('file'); + $deleted = $this->run->deleteFile($id, $filename); + + if ($deleted) { + alert('File Deleted', 'alert-success'); + } else { + alert('Unable to delete selected file', 'alert-danger'); + } + + $this->request->redirect(admin_run_url($this->run->name, 'upload_files')); + } + + private function settingsAction() { + $osf_projects = array(); + + if (($token = OSF::getUserAccessToken($this->user))) { + $osf = new OSF(Config::get('osf')); + $osf->setAccessToken($token); + $response = $osf->getProjects(); + + if ($response->hasError()) { + alert($response->getError(), 'alert-danger'); + $token = null; + } else { + foreach ($response->getJSON()->data as $project) { + $osf_projects[] = array('id' => $project->id, 'name' => $project->attributes->title); + } + } + } + + $this->setView('run/settings', array( + 'osf_token' => $token, + 'run_selected' => $this->request->getParam('run'), + 'osf_projects' => $osf_projects, + 'osf_project' => $this->run->osf_project_id, + 'run_id' => $this->run->id, + 'reminders' => $this->run->getSpecialUnits(true, 'ReminderEmail'), + 'service_messages' => $this->run->getSpecialUnits(true, 'ServiceMessagePage'), + 'overview_scripts' => $this->run->getSpecialUnits(true, 'OverviewScriptPage'), + )); + + return $this->sendResponse(); + } + + private function renameRunAction() { + $run = $this->run; + if ($this->request->isHTTPPostRequest()) { + $run_name = $this->request->str('new_name'); + if (!$run_name) { + $error = 'You have to specify a new run name'; + } elseif (!preg_match("/^[a-zA-Z][a-zA-Z0-9-]{2,255}$/", $run_name)) { + $error = 'The run name can contain a to Z, 0 to 9 and the hyphen(-) (at least 2 characters, at most 255). It needs to start with a letter.'; + } elseif ($run_name == Run::TEST_RUN || Router::isWebRootDir($run_name) || in_array($run_name, Config::get('reserved_run_names', array())) || Run::nameExists($run_name)) { + $error = __('The run name "%s" is already taken. Please choose another name', $run_name); + } else { + if ($run->rename($run_name)) { + alert("Success. Run was renamed to '{$run_name}'.", 'alert-success'); + $this->request->redirect(admin_run_url($run_name)); + } else { + $error = 'An error renaming your run please try again'; + } + } + + if (!empty($error)) { + alert("Error: {$error}", 'alert-danger'); + } + } + + $this->setView('run/rename_run'); + return $this->sendResponse(); + } + + private function exportDataAction() { + $run = $this->run; + $format = $this->request->str('format'); + $SPR = new SpreadsheetReader(); + SpreadsheetReader::verifyExportFormat($format); + + /* @var $resultsStmt PDOStatement */ + $resultsStmt = $run->getData(true); + if (!$resultsStmt->columnCount()) { + alert('No linked data yet', 'alert-info'); + $this->request->redirect(admin_run_url($run->name)); + } + + $filename = $run->name . '_data'; + switch ($format) { + case 'xlsx': + $downloaded = $SPR->exportXLSX($resultsStmt, $filename); + break; + case 'xls': + $downloaded = $SPR->exportXLS($resultsStmt, $filename); + break; + case 'csv_german': + $downloaded = $SPR->exportCSV_german($resultsStmt, $filename); + break; + case 'tsv': + $downloaded = $SPR->exportTSV($resultsStmt, $filename); + break; + case 'json': + $downloaded = $SPR->exportJSON($resultsStmt, $filename); + break; + default: + $downloaded = $SPR->exportCSV($resultsStmt, $filename); + break; + } + + if (!$downloaded) { + alert('An error occured during results download.', 'alert-danger'); + $this->request->redirect(admin_run_url($run->name)); + } + } + + private function exportSurveyResultsAction() { + $studies = $this->run->getAllSurveys(); + $dir = APPLICATION_ROOT . 'tmp/backups/results'; + if (!$dir) { + alert('Unable to create run backup directory', 'alert-danger'); + $this->request->redirect(admin_run_url($this->run->name)); + } + + // create study result files + $SPR = new SpreadsheetReader(); + $errors = $files = $metadata = array(); + $metadata['run'] = array( + 'ID' => $this->run->id, + 'NAME' => $this->run->name, + ); + + foreach ($studies as $study) { + $survey = Survey::loadById($study['id']); + $backupFile = $dir . '/' . $this->run->name . '-' . $survey->name . '.tab'; + $backup = $SPR->exportTSV($survey->getResults(null, null, null, $this->run->id, true), $survey->name, $backupFile); + if (!$backup) { + $errors[] = "Unable to backup {$survey->name}"; + } else { + $files[] = $backupFile; + } + $metadata['survey:' . $survey->id] = array( + 'ID' => $survey->id, + 'NAME' => $survey->name, + 'RUN_ID' => $this->run->id + ); + } + + $metafile = $dir . '/' . $this->run->name . '.metadata'; + if (create_ini_file($metadata, $metafile)) { + $files[] = $metafile; + } + + // zip files and send to + if ($files) { + $zipfile = $dir . '/' . $this->run->name . '-' . date('d-m-Y') . '.zip'; + + //create the archive + if (!create_zip_archive($files, $zipfile)) { + alert('Unable to create zip archive: ' . basename($zipfile), 'alert-danger'); + $this->request->redirect(admin_run_url($this->run->name)); + } + + $filename = basename($zipfile); + header("Content-Type: application/zip"); + header("Content-Disposition: attachment; filename=$filename"); + header("Content-Length: " . filesize($zipfile)); + readfile($zipfile); + // attempt to cleanup files after download + $files[] = $zipfile; + deletefiles($files); + exit; + } else { + alert('No files to zip and download', 'alert-danger'); + } + $this->request->redirect(admin_run_url($this->run->name)); + } + + private function randomGroupsExportAction() { + $run = $this->run; + $format = $this->request->str('format'); + $SPR = new SpreadsheetReader(); + SpreadsheetReader::verifyExportFormat($format); + + /* @var $resultsStmt PDOStatement */ + $resultsStmt = $run->getRandomGroups(); //@TODO unset run_name, unit_type, ended, position + if (!$resultsStmt->columnCount()) { + alert('No linked data yet', 'alert-info'); + $this->request->redirect(admin_run_url($run->name)); + } + + $filename = "Shuffle_Run_" . $run->name; + switch ($format) { + case 'xlsx': + $downloaded = $SPR->exportXLSX($resultsStmt, $filename); + break; + case 'xls': + $downloaded = $SPR->exportXLS($resultsStmt, $filename); + break; + case 'csv_german': + $downloaded = $SPR->exportCSV_german($resultsStmt, $filename); + break; + case 'tsv': + $downloaded = $SPR->exportTSV($resultsStmt, $filename); + break; + case 'json': + $downloaded = $SPR->exportJSON($resultsStmt, $filename); + break; + default: + $downloaded = $SPR->exportCSV($resultsStmt, $filename); + break; + } + + if (!$downloaded) { + alert('An error occured during results download.', 'alert-danger'); + $this->request->redirect(admin_run_url($run->name)); + } + } + + private function randomGroupsAction() { + $run = $this->run; + $pdoStatement = $run->getRandomGroups(); + + $this->setView('run/random_groups', array('users' => $pdoStatement->fetchAll(PDO::FETCH_ASSOC))); + return $this->sendResponse(); + } + + private function overviewAction() { + $this->setView('run/overview', array( + 'users' => $this->run->getNumberOfSessionsInRun(), + 'overview_script' => $this->run->getOverviewScript(), + 'user_overview' => $this->run->getUserCounts(), + )); + + return $this->sendResponse(); + } + + private function emptyRunAction() { + $run = $this->run; + if ($this->request->isHTTPPostRequest()) { + if ($this->request->getParam('empty_confirm') === $run->name) { + $run->emptySelf(); + $this->request->redirect(admin_run_url($run->name, "empty_run")); + } else { + alert("Error: You must type the run's name '{$run->name}' to empty it.", 'alert-danger'); + } + } + + $this->setView('run/empty_run', array( 'users' => $run->getNumberOfSessionsInRun())); + return $this->sendResponse(); + + } + + private function emailLogAction() { + $queryparams = array('run_id' => $this->run->id); + $helper = new RunHelper($this->run, $this->fdb, $this->request); + $table = $helper->getEmailLogTable($queryparams); + + $this->setView('run/email_log', array( + 'emails' => $table['data'], + 'pagination' => $table['pagination'], + )); + + return $this->sendResponse(); + } + + private function deleteRunAction() { + $run = $this->run; + if (Request::isHTTPPostRequest() && $this->request->getParam('delete') && $this->request->getParam('delete_confirm') === $run->name) { + if($run->delete()) { + $this->request->redirect(admin_url()); + } + } elseif (Request::isHTTPPostRequest() && $this->request->getParam('delete')) { + alert("Error: You must type the run's name '{$run->name}' to delete it.", 'alert-danger'); + } + + $this->setView('run/delete_run', array( + 'users' => $run->getNumberOfSessionsInRun(), + )); + return $this->sendResponse(); + } + + private function cronLogAction() { + $parser = new LogParser(); + $parse = $this->run->name . '.log'; + $vars = get_defined_vars(); + + $this->setView('run/cron_log_parsed', $vars); + return $this->sendResponse(); + } + + private function sessionsQueueAction() { + $this->setView('run/sessions_queue', array( + 'stmt' => UnitSessionQueue::getRunItems($this->run), + 'run_name' => $this->run->name + )); + return $this->sendResponse(); + } + + private function setRun($name) { + if (!$name) { + return; + } + + $run = new Run($name); + if (!$run->valid) { + formr_error(404, 'Not Found', 'Requested Run does not exist or has been moved'); + } elseif (!$this->user->created($run)) { + formr_error(401, 'Unauthorized', 'You do not have access to modify this run'); + } + $this->run = $run; + } + + private function exportAction() { + $formats = array('json'); + $run = $this->run; + $site = $this->site; + + if (($units = (array) json_decode($_POST['units'])) && ($name = $site->request->str('export_name')) && preg_match('/^[a-z0-9-\s]+$/i', $name)) { + $format = $this->request->getParam('format'); + $inc_survey = $this->request->getParam('include_survey_details') === 'true'; + if (!in_array($format, $formats)) { + alert('Invalid Export format selected', 'alert-danger'); + $this->request->redirect(admin_run_url($run->name)); + } + + if (!($export = $run->export($name, $units, $inc_survey))) { + $this->response->setStatusCode(500, 'Bad Request'); + return $this->sendResponse($site->renderAlerts()); + } else { + $SPR = new SpreadsheetReader(); + $SPR->exportJSON($export, $name); + } + } else { + alert('Run Export: Missing run units or invalid run name enterd.', 'alert-danger'); + $this->request->redirect(admin_run_url($run->name)); + } + } + + private function importAction() { + if ($run_file = $this->request->getParam('run_file_name')) { + $file = Config::get('run_exports_dir') . '/' . $run_file; + } elseif (!empty($_FILES['run_file'])) { + $file = $_FILES['run_file']['tmp_name']; + } + + if (empty($file)) { + alert('Please select a run file or upload one', 'alert-danger'); + return $this->request->redirect(admin_run_url($this->run->name)); + } + + if (!file_exists($file)) { + alert('The corresponding import file could not be found or is not readable', 'alert-danger'); + return $this->request->redirect(admin_run_url($this->run->name)); + } + + $json_string = file_get_contents($file); + if (!$json_string) { + alert('Unable to extract JSON object from file', 'alert-danger'); + return $this->request->redirect(admin_run_url($this->run->name)); + } + + $start_position = 10; + if ($this->run->importUnits($json_string, $start_position)) { + alert('Run modules imported successfully!', 'alert-success'); + } + + $this->request->redirect(admin_run_url($this->run->name)); + } + + private function createRunUnitAction() { + $redirect = $this->request->redirect ? admin_run_url($this->run->name, $this->request->redirect) : admin_run_url($this->run->name); + $unit = $this->createRunUnit(); + if ($unit->valid) { + alert('Run unit created', 'alert-success'); + } else { + alert('An unexpected error occured. Unit could not be created', 'alert-danger'); + } + $this->request->redirect(str_replace(':::', '#', $redirect)); + } + + private function deleteRunUnitAction() { + $id = (int) $this->request->unit_id; + if (!$id) { + throw new Exception('Missing Parameter'); + } + $redirect = $this->request->redirect ? admin_run_url($this->run->name, $this->request->redirect) : admin_run_url($this->run->name); + $unit = $this->createRunUnit($id); + if ($unit->valid) { + $unit->run_unit_id = $id; + $unit->removeFromRun($this->request->special); + alert('Run unit deleted', 'alert-success'); + } else { + alert('An unexpected error occured. Unit could not be deleted', 'alert-danger'); + } + $this->request->redirect(str_replace(':::', '#', $redirect)); + } + + private function panicAction() { + $settings = array( + 'locked' => 1, + 'cron_active' => 0, + 'public' => 0, + //@todo maybe do more + ); + $updated = $this->fdb->update('survey_runs', $settings, array('id' => $this->run->id)); + if ($updated) { + $msg = array("Panic mode activated for '{$this->run->name}'"); + $msg[] = " - Only you can access this run"; + $msg[] = " - The cron job for this run has been deactivated"; + $msg[] = " - The run has been 'locked' for editing"; + alert(implode("\n", $msg), 'alert-success'); + } + $this->request->redirect("admin/run/{$this->run->name}"); + } + + private function showPanicButton() { + $on = $this->run->locked === 1 && + $this->run->cron_active === 0 && + $this->run->public === 0; + return !$on; + } + + private function getUnitAddButtons() { + return array( + 'Survey' => array( + 'title' => 'Add Survey', + 'icon' => 'fa-pencil-square', + ), + 'External' => array( + 'title' => 'Add External Link', + 'icon' => 'fa-external-link-square', + ), + 'Email' => array( + 'title' => 'Add Email', + 'icon' => 'fa-envelope', + ), + 'SkipBackward' => array( + 'title' => 'Add a loop (Skip Backwards)', + 'icon' => 'fa-backward', + ), + 'Pause' => array( + 'title' => 'Add a Pause', + 'icon' => 'fa-pause', + ), + 'SkipForward' => array( + 'title' => 'Add a jump (Skip Forward)', + 'icon' => 'fa-forward', + ), + 'Wait' => array( + 'title' => 'Add Waiting Time', + 'icon' => 'fa-hourglass-half', + ), + 'Shuffle' => array( + 'title' => 'Add shuffle (Randomise Participants)', + 'icon' => 'fa-random', + ), + 'Page' => array( + 'title' => 'Add a Stop Point', + 'icon' => 'fa-stop', + ), + ); + } + } diff --git a/application/Controller/AdminSurveyController.php b/application/Controller/AdminSurveyController.php index 6db1ed2d4..585125203 100644 --- a/application/Controller/AdminSurveyController.php +++ b/application/Controller/AdminSurveyController.php @@ -2,460 +2,555 @@ class AdminSurveyController extends AdminController { - public function __construct(Site &$site) { - parent::__construct($site); - } - - public function indexAction($survey_name = '', $private_action = '') { - $this->setStudy($survey_name); - - if ($private_action) { - if (empty($this->study) || !$this->study->valid) { - throw new Exception("You cannot access this page with no valid study"); - } - $privateAction = $this->getPrivateAction($private_action); - return $this->$privateAction(); - } - - if ($this->request->isHTTPPostRequest()) { - $request = new Request($_POST); - $this->study->changeSettings($request->getParams()); - redirect_to(admin_study_url($this->study->name)); - } - - if (empty($this->study)) { - redirect_to(admin_url('survey/add_survey')); - } - - $this->renderView('survey/index', array( - 'survey_id' => $this->study->id, - )); - } - - public function listAction() { - $vars = array( - 'studies' => $this->user->getStudies('id DESC', null), - ); - $this->renderView('survey/list', $vars); - } - - public function addSurveyAction() { - $settings = $updates = array(); - if (Request::isHTTPPostRequest() && $this->request->google_sheet && $this->request->survey_name) { - $file = google_download_survey_sheet($this->request->survey_name, $this->request->google_sheet); - if (!$file) { - alert("Unable to download the file at '{$this->request->google_sheet}'", 'alert-danger'); - } else { - $updates['google_file_id'] = $file['google_id']; - } - } elseif (Request::isHTTPPostRequest() && !isset($_FILES['uploaded'])) { - alert('Error: You have to select an item table file here.', 'alert-danger'); - } elseif (isset($_FILES['uploaded'])) { - $file = $_FILES['uploaded']; - } - - if (!empty($file)) { - unset($_SESSION['study_id']); - unset($_GET['study_name']); - - $allowed_size = Config::get('admin_maximum_size_of_uploaded_files'); - if ($allowed_size && $file['size'] > $allowed_size * 1024 * 1024): - alert("File exceeds allowed size of {$allowed_size} MB", 'alert-danger'); - else: - $filename = basename($file['name']); - $survey_name = preg_filter("/^([a-zA-Z][a-zA-Z0-9_]{2,64})(-[a-z0-9A-Z]+)?\.[a-z]{3,4}$/", "$1", $filename); // take only the first part, before the dash if present or the dot - - $study = new Survey($this->fdb, null, array( - 'name' => $survey_name, - 'user_id' => $this->user->id - ), null, null); - - if ($study->createIndependently($settings, $updates)) { - $confirmed_deletion = true; - $created_new = true; - if ($study->uploadItemTable($file, $confirmed_deletion, $updates, $created_new)) { - alert('Success! New survey created!', 'alert-success'); - delete_tmp_file($file); - redirect_to(admin_study_url($study->name, 'show_item_table')); - } else { - alert('Bugger! A new survey was created, but there were problems with your item table. Please fix them and try again.', 'alert-danger'); - delete_tmp_file($file); - redirect_to(admin_study_url($study->name, 'upload_items')); - } - } - endif; - delete_tmp_file($file); - } - - $vars = array('google' => array()); - $this->renderView('survey/add_survey', $vars); - } - - - private function uploadItemsAction() { - $updates = array(); - $study = $this->study; - $google_id = $study->getGoogleFileId(); - $vars = array( - 'study_name' => $study->name, - 'google' => array('id' => $google_id, 'link' => google_get_sheet_link($google_id), 'name' => $study->name), - ); - - if(Request::isHTTPPostRequest()): - $confirmed_deletion = false; - if(isset($this->request->delete_confirm)): - $confirmed_deletion = $this->request->delete_confirm; - endif; - if (trim($confirmed_deletion) == ''): - $confirmed_deletion = false; - elseif ($confirmed_deletion === $study->name): - $confirmed_deletion = true; - else: - alert("Error: You confirmed the deletion of the study's results but your input did not match the study's name. Update aborted.", 'alert-danger'); - $confirmed_deletion = false; - redirect_to(admin_study_url($study->name, 'upload_items')); - return false; - endif; - endif; - - $file = null; - if (isset($_FILES['uploaded']) AND $_FILES['uploaded']['name'] !== "") { - $filename = basename($_FILES['uploaded']['name']); - $survey_name = preg_filter("/^([a-zA-Z][a-zA-Z0-9_]{2,64})(-[a-z0-9A-Z]+)?\.[a-z]{3,4}$/", "$1", $filename); // take only the first part, before the dash if present or the dot if present - - if ($study->name !== $survey_name) { - alert('Error: The uploaded file name
' . htmlspecialchars($survey_name) . ' did not match the study name ' . $study->name . '.', 'alert-danger');
- } else {
- $file = $_FILES['uploaded'];
- }
-
- } elseif (Request::isHTTPPostRequest() && $this->request->google_sheet) {
- $file = google_download_survey_sheet($study->name, $this->request->google_sheet);
- if (!$file) {
- alert("Unable to download the file at '{$this->request->google_id}'", 'alert-danger');
- } else {
- $updates['google_file_id'] = $file['google_id'];
- }
- } elseif (Request::isHTTPPostRequest()) {
- alert('Error: You have to select an item table file or enter a Google link here.', 'alert-danger');
- }
-
- if (!empty($file)) {
- $allowed_size = Config::get('admin_maximum_size_of_uploaded_files');
- if ($allowed_size && $file['size'] > $allowed_size * 1024 * 1024):
- alert("File exceeds allowed size of {$allowed_size} MB", 'alert-danger');
- redirect_to(admin_study_url($study->name, 'upload_items'));
- return false;
- endif;
-
- if (($filename = $study->getOriginalFileName()) &&
- files_are_equal($file['tmp_name'], Config::get('survey_upload_dir') . '/' . $filename )) {
- alert("Uploaded item table was identical to last uploaded item table. - No changes carried out.", 'alert-info'); - $success = false; - } else { - $success = $study->uploadItemTable($file, $confirmed_deletion, $updates, false); - } - delete_tmp_file($file); - if($success) { - redirect_to(admin_study_url($study->name, 'show_item_table')); - } - } - - $this->renderView('survey/upload_items', $vars); - } - - private function accessAction() { - $study = $this->study; - if ($this->user->created($study)): - $session = new UnitSession($this->fdb, null, $study->id); - $session->create(); - - Session::set('dummy_survey_session', array( - "session_id" => $session->id, - "unit_id" => $study->id, - "run_session_id" => $session->run_session_id, - "run_name" => Run::TEST_RUN, - "survey_name" => $study->name - )); - - alert("Go ahead. You can test the study " . $study->name . " now.", 'alert-info'); - redirect_to(run_url(Run::TEST_RUN)); - else: - alert("Sorry. You don't have access to this study", 'alert-danger'); - redirect_to("index"); - endif; - } - - private function showItemTableAction() { - $vars = array( - 'google_id' => $this->study->getGoogleFileId(), - 'original_file' => $this->study->getOriginalFileName(), - 'results' => $this->study->getItemsWithChoices(), - 'shortcut' => $this->request->str('to', null) - ); - if(empty($vars['results'])) { - alert("No valid item table uploaded so far.", 'alert-warning'); - redirect_to(admin_study_url($this->study->name, 'upload_items')); - } else { - $this->renderView('survey/show_item_table', $vars); - } - } - - private function showItemdisplayAction() { - if ($this->study->settings['hide_results']) { - return $this->hideResults(); - } - - $filter = array( - 'session' => $this->request->str('session'), - 'results' => $this->request->str('rfilter'), - ); - - // paginate based on number of items on this sheet so that each - // run session will have all items for each pagination - $items = $this->study->getItems('id'); $ids = array(); - foreach ($items as $item) { - $ids[] = $item['id']; - } - - //$session = $this->request->str('session', null); - // show $no_sessions sessions per_page (so limit = $no_sessions * number of items in a survey) - //$limit = $this->request->int('per_page', $no_sessions * $itemsCount); - - $no_sessions = $this->request->int('sess_per_page', 10); - $count = $this->study->getResultCount(null, $filter); - $totalCount = $count['real_users'] + $count['testers']; - $limit = $no_sessions; - $page = ($this->request->int('page', 1) - 1); - $paginate = array( - 'limit' => $limit, - 'page' => $page, - 'offset' => $limit * $page, - 'count' => $totalCount, - ); - - if ($paginate['page'] < 0 || $paginate['limit'] < 0) { - throw new Exception('Invalid Page number'); - } - - $pagination = new Pagination($paginate['count'], $paginate['limit']); - $pagination->setPage($paginate['page']); - - $this->renderView('survey/show_itemdisplay', array( - 'resultCount' => $this->study->getResultCount(), - 'results' => $totalCount ? $this->study->getResultsByItemsPerSession(null, $filter, $paginate) : array(), - 'pagination' => $pagination, - 'study_name' => $this->study->name, - //'session' => $session, - 'session' => $this->request->str('session'), - 'rfilter' => $this->request->str('rfilter'), - 'results_filter' => $this->study->getResultsFilter(), - )); - } - - private function showResultsAction() { - if ($this->study->settings['hide_results']) { - return $this->hideResults(); - } - - $filter = array( - 'session' => $this->request->str('session'), - 'results' => $this->request->str('rfilter'), - ); - - $count = $this->study->getResultCount(null, $filter); - $totalCount = $count['real_users'] + $count['testers']; - $limit = $this->request->int('per_page', 100); - $page = ($this->request->int('page', 1) - 1); - $paginate = array( - 'limit' => $limit, - 'page' => $page, - 'offset' => $limit * $page, - 'order' => 'desc', - 'order_by' => 'session_id', - 'count' => $totalCount, - ); - - if ($paginate['page'] < 0 || $paginate['limit'] < 0) { - throw new Exception('Invalid Page number'); - } - - $pagination = new Pagination($paginate['count'], $paginate['limit']); - $pagination->setPage($paginate['page']); - - $this->renderView('survey/show_results', array( - 'resultCount' => $count, - 'results' => $totalCount <= 0 ? array() : $this->study->getResults(null, $filter, $paginate), - 'pagination' => $pagination, - 'study_name' => $this->study->name, - 'session' => $this->request->str('session'), - 'rfilter' => $this->request->str('rfilter'), - 'results_filter' => $this->study->getResultsFilter(), - )); - } - - private function hideResults() { - $this->renderView('survey/show_results', array( - 'resultCount' => $this->study->getResultCount(), - 'results' => array(), - 'pagination' => new Pagination(1), - 'study_name' => $this->study->name, - )); - } - - private function deleteResultsAction() { - $study = $this->study; - - if (isset($_POST['delete']) AND trim($_POST['delete_confirm']) === $study->name) { - if ($study->deleteResults()): - alert(implode($study->messages), 'alert-info'); - alert("Success. All results in '{$study->name}' were deleted.", 'alert-success'); - else: - alert(implode($study->errors), 'alert-danger'); - endif; - redirect_to(admin_study_url($study->name, 'delete_results')); - } elseif (isset($_POST['delete'])) { - alert("Error: Survey's name must match '{$study->name}' to delete results.", 'alert-danger'); - } - - $this->renderView('survey/delete_results', array( - 'resultCount' => $study->getResultCount(), - )); - } - - private function deleteStudyAction() { - $study = $this->study; - - if (isset($_POST['delete']) AND trim($_POST['delete_confirm']) === $study->name) { - $study->delete(); - alert("Success. Successfully deleted study '{$study->name}'.", 'alert-success'); - redirect_to(admin_url()); - } elseif (isset($_POST['delete'])) { - alert("Error: You must type the study's name '{$study->name}' to delete it.", 'alert-danger'); - } - - $this->renderView('survey/delete_study', array( - 'resultCount' => $study->getResultCount(), - )); - } - - private function renameStudyAction() { - $study = $this->study; - $new_name = $this->request->str('new_name'); - - if ($new_name && $new_name !== $study->name) { - $old_name = $study->name; - if($study->rename($new_name)) { - alert("Success. Successfully renamed study from '{$old_name}' to {$study->name}.", 'alert-success'); - redirect_to(admin_study_url($study->name, 'rename_study')); - } - } - - $this->renderView('survey/rename_study', array('study_name' => $study->name)); - } - - private function exportItemTableAction() { - $study = $this->study; - - $format = $this->request->getParam('format'); - SpreadsheetReader::verifyExportFormat($format); - - $SPR = new SpreadsheetReader(); - - if ($format == 'original') { - $filename = $study->getOriginalFileName(); - $file = Config::get('survey_upload_dir') . '/' . $filename; - if (!is_file($file)) { - alert('The original file could not be found. Try another format', 'alert-danger'); - redirect_to(admin_study_url($study->name)); - } - - $type = 'application/vnd.ms-excel'; - //@todo get right type - - header('Content-Disposition: attachment;filename="' . $filename . '"'); - header('Cache-Control: max-age=0'); - header('Content-Type: ' . $type); - readfile($file); - exit; - } elseif ($format == 'xlsx') { - $SPR->exportItemTableXLSX($study); - } elseif ($format == 'xls') { - $SPR->exportItemTableXLS($study); - } else { - $SPR->exportItemTableJSON($study); - } - } - private function verifyThereIsExportableData($resultsStmt) { - if ($resultsStmt->rowCount() < 1) { - alert('No data to export!', 'alert-danger'); - redirect_to(admin_study_url($this->study->name, 'show_itemdisplay')); - } - } - - private function exportItemdisplayAction() { - if ($this->study->settings['hide_results']) { - return $this->hideResults(); - } - - $study = $this->study; - $format = $this->request->str('format'); - SpreadsheetReader::verifyExportFormat($format); - - /* @var $resultsStmt PDOStatement */ - $resultsStmt = $study->getItemDisplayResults(null, null, null, true); - $this->verifyThereIsExportableData($resultsStmt); - - $SPR = new SpreadsheetReader(); - $download_successfull = $SPR->exportInRequestedFormat($resultsStmt, $study->name, $format); - if (!$download_successfull) { - alert('An error occured during results download.', 'alert-danger'); - redirect_to(admin_study_url($filename, 'show_results')); + public function __construct(Site &$site) { + parent::__construct($site); + } + + public function indexAction($survey_name = '', $private_action = '') { + $this->setStudy($survey_name); + + if ($private_action) { + if (empty($this->study) || !$this->study->valid) { + throw new Exception("You cannot access this page with no valid study"); + } + $privateAction = $this->getPrivateAction($private_action); + return $this->$privateAction(); + } + + if ($this->request->isHTTPPostRequest()) { + $this->changeSettings((new Request($_POST))->getParams()); + return $this->request->redirect(admin_study_url($this->study->name)); + } + + if (empty($this->study)) { + return $this->request->redirect(admin_url('survey/add_survey')); + } + + $this->setView('survey/index', array('survey_id' => $this->study->id)); + return $this->sendResponse(); + } + + public function listAction() { + $vars = array('studies' => $this->user->getStudies('id DESC', null),); + $this->setView('survey/list', $vars); + + return $this->sendResponse(); + } + + public function addSurveyAction() { + $settings = $updates = array(); + + if (Request::isHTTPPostRequest()) { + + if ($this->request->google_sheet && $this->request->survey_name) { + // Google sheet was used + $file = google_download_survey_sheet($this->request->survey_name, $this->request->google_sheet); + if (!$file) { + alert("Unable to download the file at '{$this->request->google_sheet}'", 'alert-danger'); + return $this->request->redirect('admin/survey'); + } + } elseif (isset($_FILES['uploaded'])) { + // Excel file was uploaded + $file = $_FILES['uploaded']; + } else { + // Nothing was uploaded + alert('Error: You have to select an item table file here.', 'alert-danger'); + return $this->request->redirect('admin/survey'); + } + + + if ($this->validateUploadedFile($file)) { + $study = new SurveyStudy(null); + if ($study->createFromFile($file)) { + // upload items + if ($study->uploadItems($file, true, true)) { + alert('Success! New survey created!', 'alert-success'); + $redirect = admin_study_url($study->name, 'show_item_table'); + } else { + alert('Bugger! A new survey was created, but there were problems with your item table. Please fix them and try again.', 'alert-danger'); + $redirect = admin_study_url($study->name, 'upload_items'); + } + + delete_tmp_file($file); + return $this->request->redirect($redirect); + } + + } else { + delete_tmp_file($file); + return $this->request->redirect('admin/survey'); + } + + } + + $vars = array('google' => array()); + $this->setView('survey/add_survey', $vars); + + return $this->sendResponse(); + } + + protected function validateUploadedFile($file, $editing = false) { + if (empty($file['name'])) { + return false; + } + + $name = preg_filter("/^([a-zA-Z][a-zA-Z0-9_]{2,64})(-[a-z0-9A-Z]+)?\.[a-z]{3,4}$/", "$1", basename($file['name'])); + if (!preg_match("/[a-zA-Z][a-zA-Z0-9_]{2,64}/", (string)$name)) { + alert("Error: The study name (the name of the file you uploaded) can only contain the characters from a to Z, 0 to 9 and the underscore. + The name has to at least 2, at most 64 characters long. It needs to start with a letter. No dots, no spaces, no dashes, no umlauts please. + The file can have version numbers after a dash, like this
survey_1-v2.xlsx, but they will be ignored.", 'alert-danger');
+ return false;
+ }
+
+ $allowed_size = Config::get('admin_maximum_size_of_uploaded_files');
+ if ($allowed_size && $file['size'] > $allowed_size * 1024 * 1024) {
+ alert("File exceeds allowed size of {$allowed_size} MB", 'alert-danger');
+ return false;
+ }
+
+ if ($this->fdb->entry_exists('survey_studies', array('name' => $name, 'user_id' => $this->user->id)) && $editing === false) {
+ alert(__("Error: The survey name %s is already taken.", h($name)), 'alert-danger');
+ return false;
+ }
+
+ return true;
+ }
+
+ private function uploadItemsAction() {
+ $updates = array();
+ $study = $this->study;
+ $google_id = $study->google_file_id;
+
+ $vars = array(
+ 'study_name' => $study->name,
+ 'google' => array(
+ 'id' => $google_id,
+ 'link' => google_get_sheet_link($google_id),
+ 'name' => $study->name
+ ),
+ );
+
+ if (Request::isHTTPPostRequest()) {
+ $can_delete = false;
+ if ($this->request->delete_confirm) {
+ if ($this->request->delete_confirm !== $study->name) {
+ alert("Error: You confirmed the deletion of the study's results but your input did not match the study's name. Update aborted.", 'alert-danger');
+ return $this->request->redirect(admin_study_url($study->name, 'upload_items'));
+ }
+
+ $can_delete = true;
+ }
+
+ if ($this->request->google_sheet) {
+ // Google sheet was used
+ $file = google_download_survey_sheet($study->name, $this->request->google_sheet);
+ if (!$file) {
+ alert("Unable to download the file at '{$this->request->google_sheet}'", 'alert-danger');
+ return $this->request->redirect(admin_study_url($study->name, 'upload_items'));
+ }
+
+ if ($study->google_file_id != $file['google_file_id']) {
+ $study->google_file_id = $file['google_file_id'];
+ $study->save();
+ }
+ } elseif (isset($_FILES['uploaded'])) {
+ // Excel file was uploaded
+ $file = $_FILES['uploaded'];
+ } else {
+ // Nothing was uploaded
+ alert('Error: You have to select an item table file here.', 'alert-danger');
+ return $this->request->redirect(admin_study_url($study->name, 'upload_items'));
+ }
+
+
+ if ($this->validateUploadedFile($file, true)) {
+ $survey_name = preg_filter("/^([a-zA-Z][a-zA-Z0-9_]{2,64})(-[a-z0-9A-Z]+)?\.[a-z]{3,4}$/", "$1", basename($file['name']));
+ if ($study->name !== $survey_name) {
+ alert('Error: The uploaded file name ' . htmlspecialchars($survey_name) . ' did not match the study name ' . $study->name . '.', 'alert-danger');
+ delete_tmp_file($file);
+ return $this->request->redirect(admin_study_url($study->name, 'upload_items'));
+ }
+
+ if (($filename = $study->getOriginalFileName()) && files_are_equal($file['tmp_name'], Config::get('survey_upload_dir') . '/' . $filename)) {
+ alert("Uploaded item table was identical to last uploaded item table. No changes carried out.", 'alert-info'); + delete_tmp_file($file); + return $this->request->redirect(admin_study_url($study->name, 'upload_items')); } - } - - private function exportResultsAction() { - if ($this->study->settings['hide_results']) { - return $this->hideResults(); - } - - $study = $this->study; - $format = $this->request->str('format'); - - - /* @var $resultsStmt PDOStatement */ - $resultsStmt = $study->getResults(null, null, null, null, true); - $this->verifyThereIsExportableData($resultsStmt); - - $SPR = new SpreadsheetReader(); - $download_successfull = $SPR->exportInRequestedFormat($resultsStmt, $study->name, $format); - if (!$download_successfull) { - alert('An error occured during results download.', 'alert-danger'); - redirect_to(admin_study_url($filename, 'show_results')); + if ($study->uploadItems($file, $can_delete, false)) { + // upload items + alert('Success! Survey items uploaded!', 'alert-success'); + delete_tmp_file($file); + return $this->request->redirect(admin_study_url($study->name, 'upload_items')); } - } - - private function setStudy($name) { - if (!$name) { - return; - } - - $study = new Survey($this->fdb, null, array('name' => $name, 'user_id' => $this->user->id), null, null); - if (!$study->valid) { - formr_error(404, 'Not Found', 'Requested Survey does not exist or has been moved'); - } elseif (!$this->user->created($study)) { - formr_error(401, 'Unauthorized', 'You do not have access to modify this survey'); - } - - $google_id = $study->getGoogleFileId(); - $this->vars['google'] = array( - 'id' => $google_id, - 'link' => google_get_sheet_link($google_id), - 'name' => $study->name - ); - $this->study = $study; - } + + } else { + delete_tmp_file($file); + return $this->request->redirect('admin/survey'); + } + + } + + $this->setView('survey/upload_items', $vars); + return $this->sendResponse(); + } + + private function accessAction() { + Session::set('test_study_data', array( + 'study_id' => $this->study->id, + 'study_name' => $this->study->name, + 'unit_id' => $this->study->id, + 'data' => $this->study->getItems('id, name, type'), + )); + + alert("Go ahead. You can test the study " . $this->study->name . " now.", 'alert-info'); + $this->request->redirect(run_url(Run::TEST_RUN)); + } + + private function showItemTableAction() { + $vars = array( + 'google_id' => $this->study->getGoogleFileId(), + 'original_file' => $this->study->getOriginalFileName(), + 'results' => $this->study->getItemsWithChoices(), + 'shortcut' => $this->request->str('to', null) + ); + + if (empty($vars['results'])) { + alert("No valid item table uploaded so far.", 'alert-warning'); + $this->request->redirect(admin_study_url($this->study->name, 'upload_items')); + } else { + $this->setView('survey/show_item_table', $vars); + return $this->sendResponse(); + } + } + + private function showItemdisplayAction() { + if ($this->study->hide_results) { + return $this->hideResults(); + } + + $filter = array( + 'session' => $this->request->str('session'), + 'results' => $this->request->str('rfilter'), + ); + + // paginate based on number of items on this sheet so that each + // run session will have all items for each pagination + $items = $this->study->getItems('id'); + $ids = array(); + foreach ($items as $item) { + $ids[] = $item['id']; + } + + $no_sessions = $this->request->int('sess_per_page', 10); + $count = $this->study->getResultCount(null, $filter); + $totalCount = $count['real_users'] + $count['testers']; + $limit = $no_sessions; + $page = ($this->request->int('page', 1) - 1); + $paginate = array( + 'limit' => $limit, + 'page' => $page, + 'offset' => $limit * $page, + 'count' => $totalCount, + ); + + if ($paginate['page'] < 0 || $paginate['limit'] < 0) { + throw new Exception('Invalid Page number'); + } + + $pagination = new Pagination($paginate['count'], $paginate['limit']); + $pagination->setPage($paginate['page']); + + $this->setView('survey/show_itemdisplay', array( + 'resultCount' => $this->study->getResultCount(), + 'results' => $totalCount ? $this->study->getResultsByItemsPerSession(null, $filter, $paginate) : array(), + 'pagination' => $pagination, + 'study_name' => $this->study->name, + //'session' => $session, + 'session' => $this->request->str('session'), + 'rfilter' => $this->request->str('rfilter'), + 'results_filter' => $this->study->getResultsFilter(), + )); + + return $this->sendResponse(); + } + + private function showResultsAction() { + if ($this->study->hide_results) { + return $this->hideResults(); + } + + $filter = array( + 'session' => $this->request->str('session'), + 'results' => $this->request->str('rfilter'), + ); + + $count = $this->study->getResultCount(null, $filter); + $totalCount = $count['real_users'] + $count['testers']; + $limit = $this->request->int('per_page', 100); + $page = ($this->request->int('page', 1) - 1); + $paginate = array( + 'limit' => $limit, + 'page' => $page, + 'offset' => $limit * $page, + 'order' => 'desc', + 'order_by' => 'session_id', + 'count' => $totalCount, + ); + + if ($paginate['page'] < 0 || $paginate['limit'] < 0) { + throw new Exception('Invalid Page number'); + } + + $pagination = new Pagination($paginate['count'], $paginate['limit']); + $pagination->setPage($paginate['page']); + + $this->setView('survey/show_results', array( + 'resultCount' => $count, + 'results' => $totalCount <= 0 ? array() : $this->study->getResults(null, $filter, $paginate), + 'pagination' => $pagination, + 'study_name' => $this->study->name, + 'session' => $this->request->str('session'), + 'rfilter' => $this->request->str('rfilter'), + 'results_filter' => $this->study->getResultsFilter(), + )); + + return $this->sendResponse(); + } + + private function hideResults() { + $this->setView('survey/show_results', array( + 'resultCount' => $this->study->getResultCount(), + 'results' => array(), + 'pagination' => new Pagination(1), + 'study_name' => $this->study->name, + )); + + return $this->sendResponse(); + } + + private function deleteResultsAction() { + $study = $this->study; + + if (Request::isHTTPPostRequest() && $this->request->getParam('delete_confirm') === $study->name) { + if ($study->deleteResults()) { + alert(implode($study->messages), 'alert-info'); + alert("Success. All results in '{$study->name}' were deleted.", 'alert-success'); + } else { + alert(implode($study->errors), 'alert-danger'); + } + $this->request->redirect(admin_study_url($study->name, 'delete_results')); + } elseif (Request::isHTTPPostRequest()) { + alert("Error: Survey's name must match '{$study->name}' to delete results.", 'alert-danger'); + } + + $this->setView('survey/delete_results', array( + 'resultCount' => $study->getResultCount(), + )); + + return $this->sendResponse(); + } + + private function deleteStudyAction() { + $study = $this->study; + + if (Request::isHTTPPostRequest() && $this->request->getParam('delete_confirm') === $study->name) { + $study->delete(); + alert("Success. Successfully deleted study '{$study->name}'.", 'alert-success'); + $this->request->redirect(admin_url()); + } elseif (Request::isHTTPPostRequest()) { + alert("Error: You must type the study's name '{$study->name}' to delete it.", 'alert-danger'); + } + + $this->setView('survey/delete_study', array( + 'resultCount' => $study->getResultCount(), + )); + + return $this->sendResponse(); + } + + private function renameStudyAction() { + $study = $this->study; + $new_name = $this->request->str('new_name'); + $old_name = $study->name; + + if ($new_name && $new_name !== $study->name) { + if (!preg_match("/[a-zA-Z][a-zA-Z0-9_]{2,64}/", $new_name) || + $this->fdb->entry_exists('survey_studies', array('name' => $new_name, 'user_id' => $this->user->id))) { + + alert('A study with this name already exists', 'alert-danger'); + return $this->request->redirect(admin_study_url($study->name, 'rename_study')); + } + + $study->name = $new_name; + $study->save(); + alert("Success. Successfully renamed study from '{$old_name}' to {$study->name}.", 'alert-success'); + + return $this->request->redirect(admin_study_url($study->name, 'rename_study')); + } + + $this->setView('survey/rename_study', array('study_name' => $study->name)); + return $this->sendResponse(); + } + + private function exportItemTableAction() { + $study = $this->study; + + $format = $this->request->getParam('format'); + SpreadsheetReader::verifyExportFormat($format); + + $SPR = new SpreadsheetReader(); + + if ($format == 'original') { + $filename = $study->getOriginalFileName(); + $file = Config::get('survey_upload_dir') . '/' . $filename; + if (!is_file($file)) { + alert('The original file could not be found. Try another format', 'alert-danger'); + $this->request->redirect(admin_study_url($study->name)); + } + + $type = 'application/vnd.ms-excel'; + //@todo get right type + + header('Content-Disposition: attachment;filename="' . $filename . '"'); + header('Cache-Control: max-age=0'); + header('Content-Type: ' . $type); + readfile($file); + exit; + } elseif ($format == 'xlsx') { + $SPR->exportItemTableXLSX($study); + } elseif ($format == 'xls') { + $SPR->exportItemTableXLS($study); + } else { + $SPR->exportItemTableJSON($study); + } + } + + private function verifyThereIsExportableData($resultsStmt) { + if ($resultsStmt->rowCount() < 1) { + alert('No data to export!', 'alert-danger'); + $this->request->redirect(admin_study_url($this->study->name, 'show_itemdisplay')); + } + } + + private function exportItemdisplayAction() { + if ($this->study->hide_results) { + return $this->hideResults(); + } + + $study = $this->study; + $format = $this->request->str('format'); + SpreadsheetReader::verifyExportFormat($format); + + /* @var $resultsStmt PDOStatement */ + $resultsStmt = $study->getItemDisplayResults(null, null, null, true); + $this->verifyThereIsExportableData($resultsStmt); + + $SPR = new SpreadsheetReader(); + $download_successfull = $SPR->exportInRequestedFormat($resultsStmt, $study->name, $format); + if (!$download_successfull) { + alert('An error occured during results download.', 'alert-danger'); + $this->request->redirect(admin_study_url($study->name, 'show_results')); + } + } + + private function exportResultsAction() { + if ($this->study->hide_results) { + return $this->hideResults(); + } + + $study = $this->study; + $format = $this->request->str('format'); + + + /* @var $resultsStmt PDOStatement */ + $resultsStmt = $study->getResults(null, null, null, null, true); + $this->verifyThereIsExportableData($resultsStmt); + + $SPR = new SpreadsheetReader(); + $download_successfull = $SPR->exportInRequestedFormat($resultsStmt, $study->name, $format); + + if (!$download_successfull) { + alert('An error occured during results download.', 'alert-danger'); + $this->request->redirect(admin_study_url($filename, 'show_results')); + } + } + + private function changeSettings($settings) { + $errors = false; + array_walk($settings, function (&$value, $key) { + if ($key !== 'google_file_id') { + $value = (int) $value; + } + }); + if (isset($settings['maximum_number_displayed']) && $settings['maximum_number_displayed'] > 3000 || $settings['maximum_number_displayed'] < 0) { + alert("Maximum number displayed has to be between 1 and 3000", 'alert-warning'); + $errors = true; + } + + if (isset($settings['displayed_percentage_maximum']) && $settings['displayed_percentage_maximum'] > 100 || $settings['displayed_percentage_maximum'] < 1) { + alert("Percentage maximum has to be between 1 and 100.", 'alert-warning'); + $errors = true; + } + + if (isset($settings['add_percentage_points']) && $settings['add_percentage_points'] > 100 || $settings['add_percentage_points'] < 0) { + alert("Percentage points added has to be between 0 and 100.", 'alert-warning'); + $errors = true; + } + + $settings['enable_instant_validation'] = (int) (isset($settings['enable_instant_validation']) && $settings['enable_instant_validation'] == 1); + $settings['hide_results'] = (int) (isset($settings['hide_results']) && $settings['hide_results'] === 1); + $settings['use_paging'] = (int) (isset($settings['use_paging']) && $settings['use_paging'] === 1); + $settings['unlinked'] = (int) (isset($settings['unlinked']) && $settings['unlinked'] === 1); + + // user can't revert unlinking + if ($settings['unlinked'] < $this->study->unlinked) { + alert("Once a survey has been unlinked, it cannot be relinked.", 'alert-warning'); + $errors = true; + } + + // user can't revert preventing results display + if ($settings['hide_results'] < $this->study->hide_results) { + alert("Once results display is disabled, it cannot be re-enabled.", 'alert-warning'); + $errors = true; + } + + // user can't revert preventing results display + if ($settings['use_paging'] < $this->study->use_paging) { + alert("Once you have enabled the use of custom paging, you can't revert this setting.", 'alert-warning'); + $errors = true; + } + + if (isset($settings['expire_after']) && $settings['expire_after'] > 3153600) { + alert("Survey expiry time (in minutes) has to be below 3153600.", 'alert-warning'); + $errors = true; + } + + if ($errors) { + return false; + } + + $this->study->update($settings); + + alert('Survey settings updated', 'alert-success', true); + } + + private function setStudy($name) { + if (!$name) { + return; + } + + $study = SurveyStudy::loadByUserAndName($this->user, $name); + if (!$study->valid) { + formr_error(404, 'Not Found', 'Requested Survey does not exist or has been moved'); + } + + $google_id = $study->getGoogleFileId(); + $this->vars['google'] = array( + 'id' => $google_id, + 'link' => google_get_sheet_link($google_id), + 'name' => $study->name + ); + $this->study = $study; + } } diff --git a/application/Controller/ApiController.php b/application/Controller/ApiController.php index cc36341ec..62e85fa46 100644 --- a/application/Controller/ApiController.php +++ b/application/Controller/ApiController.php @@ -1,217 +1,219 @@ initialize(); - } - - public function indexAction() { - $this->sendResponse(Response::STATUS_FORBIDDEN, 'Invalid', array('error' => 'No Entry Point')); - } - - public function oauthAction($action = null) { - if (!$this->isValidAction('oauth', $action)) { - $this->response->badRequest('Invalid Auth Request'); - } - - $this->oauthServer = Site::getOauthServer(); - if ($action === 'authorize') { - $this->authorize(); - } elseif ($action === 'access_token') { - $this->access_token(); - } - } - - public function postAction($action = null) { - if (!Request::isHTTPPostRequest()) { - $this->response->badMethod('Invalid Request Method'); - } - - if (!$this->isValidAction('post', $action)) { - $this->response->badRequest('Invalid Post Request'); - } - - $this->doAction($this->post, $action); - } - - public function getAction($action = null) { - if (!Request::isHTTPGetRequest()) { - $this->response->badMethod('Invalid Request Method'); - } - - if (!$this->isValidAction('get', $action)) { - $this->response->badRequest('Invalid Get Request'); - } - - $this->doAction($this->get, $action); - } - - public function osfAction($do = '') { - $user = Site::getCurrentUser(); - if (!$user->loggedIn()) { - alert('You need to login to access this section', 'alert-warning'); - redirect_to('login'); - } - - $osfconfg = Config::get('osf'); - $osfconfg['state'] = $user->user_code; - - $osf = new OSF($osfconfg); - - // Case 1: User wants to login to give formr authorization - // If user has a valid access token then just use it (i.e redirect to where access token is needed - if ($do === 'login') { - $redirect = $this->request->getParam('redirect', 'admin/osf') . '#osf'; - if ($token = OSF::getUserAccessToken($user)) { - // redirect user to where he came from and get access token from there for current user - alert('You have authorized FORMR to act on your behalf on the OSF', 'alert-success'); - } else { - Session::set('formr_redirect', $redirect); - // redirect user to login link - $redirect = $osf->getLoginUrl(); - } - redirect_to($redirect); - } - - // Case 2: User is oauth2-ing. Handle authorization code exchange - if ($code = $this->request->getParam('code')) { - if ($this->request->getParam('state') != $user->user_code) { - throw new Exception("Invalid OSF-OAUTH 2.0 request"); - } - - $params = $this->request->getParams(); - try { - $logged = $osf->login($params); - } catch (Exception $e) { - formr_log_exception($e, 'OSF'); - $logged = array('error' => $e->getMessage()); - } - - if (!empty($logged['access_token'])) { - // save this access token for this user - // redirect user to where osf actions need to happen (@todo pass this in a 'redirect session parameter' - OSF::setUserAccessToken($user, $logged); - alert('You have authorized FORMR to act on your behalf on the OSF', 'alert-success'); - if ($redirect = Session::get('formr_redirect')) { - Session::delete('formr_redirect'); - } else { - $redirect = 'admin/osf'; - } - redirect_to($redirect); - } else { - $error = !empty($logged['error']) ? $logged['error'] : 'Access token could not be obtained'; - alert('OSF API Error: ' . $error, 'alert-danger'); - redirect_to('admin'); - } - } - - // Case 3: User is oauth2-ing. Handle case when user cancels authorization - if ($error = $this->request->getParam('error')) { - alert('Access was denied at OSF-Formr with error code: ' . $error, 'alert-danger'); - redirect_to('admin'); - } - - redirect_to('index'); - } - - - protected function doAction(Request $request, $action) { - try { - $this->authenticate($action); // only proceed if authenticated, if not exit via response - $method = $this->getPrivateAction($action, '-', true); - $helper = new ApiHelper($request, $this->fdb); - $data = $helper->{$method}()->getData(); - } catch (Exception $e) { - formr_log_exception($e, 'API'); - $data = array( - 'statusCode' => Response::STATUS_INTERNAL_SERVER_ERROR, - 'statusText' => 'Internal Server Error', - 'response' => array('error' => 'An unexpected error occured', 'error_code' => Response::STATUS_INTERNAL_SERVER_ERROR), - ); - } - - $this->sendResponse($data['statusCode'], $data['statusText'], $data['response']); - } - - protected function isValidAction($type, $action) { - $actions = array( - 'oauth' => array('authorize', 'access_token'), - 'post' => array('create-session', 'end-last-external'), - 'get' => array('results'), - ); - - return isset($actions[$type]) && in_array($action, $actions[$type]); - } - - protected function authorize() { - /* - * @todo - * Implement authorization under oauth - */ - $this->response->badRequest('Not Implemented'); - } - - protected function access_token() { - // Ex: curl -u testclient:testpass http://formr.org/api/oauth/token -d 'grant_type=client_credentials' - $this->oauthServer->handleTokenRequest(OAuth2\Request::createFromGlobals())->send(); - } - - protected function authenticate($action) { - $publicActions = array("end-last-external"); - if(!in_array($action, $publicActions) ) { - $this->oauthServer = Site::getOauthServer(); - // Handle a request to a resource and authenticate the access token - // Ex: curl http://formr.org/api/post/action-name -d 'access_token=YOUR_TOKEN' - if (!$this->oauthServer->verifyResourceRequest(OAuth2\Request::createFromGlobals())) { - $this->sendResponse(Response::STATUS_UNAUTHORIZED, 'Unauthorized Access', array( - 'error' => 'Invalid/Unauthorized access token', - 'error_code' => Response::STATUS_UNAUTHORIZED, - 'error_description' => 'Access token for this resouce request is invalid or unauthorized', - )); - } - } - } - - protected function sendResponse($statusCode = Response::STATUS_OK, $statusText = 'OK', $response = null) { - $this->response->setStatusCode($statusCode, $statusText); - $this->response->setContentType('application/json'); - $this->response->setJsonContent($response); - $this->response->send(); - } - - protected function initialize() { - $this->post = new Request($_POST); - $this->get = new Request($_GET); - $this->response = new Response(); - } + /** + * POST Request variables + * + * @var Request + */ + protected $post; + + /** + * GET Request variables + * + * @var Request + */ + protected $get; + + /** + * @var Response + */ + protected $response; + + /** + * @var OAuth2\Server + */ + protected $oauthServer; + + protected $unrestrictedActions = ['end-last-external']; + + public function __construct(Site &$site) { + parent::__construct($site); + $this->initialize(); + } + + public function indexAction() { + $this->respond(Response::STATUS_FORBIDDEN, 'Invalid', array('error' => 'No Entry Point')); + } + + public function oauthAction($action = null) { + if (!$this->isValidAction('oauth', $action)) { + $this->response->badRequest('Invalid Auth Request'); + } + + $this->oauthServer = Site::getOauthServer(); + if ($action === 'authorize') { + $this->authorize(); + } elseif ($action === 'access_token') { + $this->access_token(); + } + } + + public function postAction($action = null) { + if (!Request::isHTTPPostRequest()) { + $this->response->badMethod('Invalid Request Method'); + } + + if (!$this->isValidAction('post', $action)) { + $this->response->badRequest('Invalid Post Request'); + } + + $this->doAction($this->post, $action); + } + + public function getAction($action = null) { + if (!Request::isHTTPGetRequest()) { + $this->response->badMethod('Invalid Request Method'); + } + + if (!$this->isValidAction('get', $action)) { + $this->response->badRequest('Invalid Get Request'); + } + + $this->doAction($this->get, $action); + } + + public function osfAction($do = '') { + $user = Site::getCurrentUser(); + if (!$user->loggedIn()) { + alert('You need to login to access this section', 'alert-warning'); + redirect_to('login'); + } + + $osfconfg = Config::get('osf'); + $osfconfg['state'] = $user->user_code; + + $osf = new OSF($osfconfg); + + // Case 1: User wants to login to give formr authorization + // If user has a valid access token then just use it (i.e redirect to where access token is needed + if ($do === 'login') { + $redirect = $this->request->getParam('redirect', 'admin/osf') . '#osf'; + if ($token = OSF::getUserAccessToken($user)) { + // redirect user to where he came from and get access token from there for current user + alert('You have authorized FORMR to act on your behalf on the OSF', 'alert-success'); + } else { + Session::set('formr_redirect', $redirect); + // redirect user to login link + $redirect = $osf->getLoginUrl(); + } + redirect_to($redirect); + } + + // Case 2: User is oauth2-ing. Handle authorization code exchange + if ($code = $this->request->getParam('code')) { + if ($this->request->getParam('state') != $user->user_code) { + throw new Exception("Invalid OSF-OAUTH 2.0 request"); + } + + $params = $this->request->getParams(); + try { + $logged = $osf->login($params); + } catch (Exception $e) { + formr_log_exception($e, 'OSF'); + $logged = array('error' => $e->getMessage()); + } + + if (!empty($logged['access_token'])) { + // save this access token for this user + // redirect user to where osf actions need to happen (@todo pass this in a 'redirect session parameter' + OSF::setUserAccessToken($user, $logged); + alert('You have authorized FORMR to act on your behalf on the OSF', 'alert-success'); + if ($redirect = Session::get('formr_redirect')) { + Session::delete('formr_redirect'); + } else { + $redirect = 'admin/osf'; + } + redirect_to($redirect); + } else { + $error = !empty($logged['error']) ? $logged['error'] : 'Access token could not be obtained'; + alert('OSF API Error: ' . $error, 'alert-danger'); + redirect_to('admin'); + } + } + + // Case 3: User is oauth2-ing. Handle case when user cancels authorization + if ($error = $this->request->getParam('error')) { + alert('Access was denied at OSF-Formr with error code: ' . $error, 'alert-danger'); + redirect_to('admin'); + } + + redirect_to('index'); + } + + protected function doAction(Request $request, $action) { + try { + $this->authenticate($action); // only proceed if authenticated, if not exit via response + $method = $this->getPrivateAction($action, '-', true); + $helper = new ApiHelper($request, $this->fdb); + $data = $helper->{$method}()->getData(); + } catch (Exception $e) { + formr_log_exception($e, 'API'); + $data = array( + 'statusCode' => Response::STATUS_INTERNAL_SERVER_ERROR, + 'statusText' => 'Internal Server Error', + 'response' => array('error' => 'An unexpected error occured', 'error_code' => Response::STATUS_INTERNAL_SERVER_ERROR), + ); + } + + $this->respond($data['statusCode'], $data['statusText'], $data['response']); + } + + protected function isValidAction($type, $action) { + $actions = array( + 'oauth' => array('authorize', 'access_token'), + 'post' => array('create-session', 'end-last-external'), + 'get' => array('results'), + ); + + return isset($actions[$type]) && in_array($action, $actions[$type]); + } + + protected function authorize() { + /* + * @todo + * Implement authorization under oauth + */ + $this->response->badRequest('Not Implemented'); + } + + protected function access_token() { + // Ex: curl -u testclient:testpass http://formr.org/api/oauth/token -d 'grant_type=client_credentials' + $this->oauthServer->handleTokenRequest(OAuth2\Request::createFromGlobals())->send(); + } + + protected function authenticate($action) { + if (!in_array($action, $this->unrestrictedActions)) { + $this->oauthServer = Site::getOauthServer(); + // Handle a request to a resource and authenticate the access token + // Ex: curl http://formr.org/api/post/action-name -d 'access_token=YOUR_TOKEN' + if (!$this->oauthServer->verifyResourceRequest(OAuth2\Request::createFromGlobals())) { + $this->respond(Response::STATUS_UNAUTHORIZED, 'Unauthorized Access', array( + 'error' => 'Invalid/Unauthorized access token', + 'error_code' => Response::STATUS_UNAUTHORIZED, + 'error_description' => 'Access token for this resouce request is invalid or unauthorized', + )); + } + } + } + + protected function respond($statusCode = Response::STATUS_OK, $statusText = 'OK', $response = null) { + $this->response->setStatusCode($statusCode, $statusText); + $this->response->setContentType('application/json'); + $this->response->setJsonContent($response); + return $this->sendResponse(); + } + + protected function initialize() { + $this->view = null; + $this->post = new Request($_POST); + $this->get = new Request($_GET); + $this->response = new Response(); + } } diff --git a/application/Controller/Controller.php b/application/Controller/Controller.php index e61f53147..83ea327fc 100644 --- a/application/Controller/Controller.php +++ b/application/Controller/Controller.php @@ -2,185 +2,229 @@ abstract class Controller { - /** - * - * @var Site - */ - protected $site; - - /** - * - * @var User - */ - protected $user; - - /** - * - * @var Run - */ - public $run; - - /** - * - * @var DB - */ - protected $fdb; - - /** - * - * @var Survey - */ - public $study; - - /** - * - * @var Request - */ - protected $request; - - protected $css = array(); - - protected $js = array(); - - protected $vars = array(); - - public function __construct(Site &$site) { - /** @todo do these with dependency injection */ - global $user, $run, $study, $css, $js; - $this->site = $site; - $this->user = &$user; - $this->study = $study; - $this->run = $run; - if (is_array($css)) { - $this->css = $css; - } - if (is_array($js)) { - $this->js = $js; - } - - $this->fdb = DB::getInstance(); - $this->request = $site->request; - } - - protected function renderView($template, $vars = array()) { - $variables = array_merge(array( - 'site' => $this->site, - 'user' => $this->user, - 'fdb' => $this->fdb, - 'js' => $this->js, - 'css' => $this->css, - 'run' => $this->run, - 'study' => $this->study, - 'meta' => $this->generateMetaInfo(), - ), $this->vars, $vars); - Request::setGlobals('variables', $variables); - Template::load($template); - } - - protected function getPrivateAction($name, $separator = '_', $protected = false) { - $parts = array_filter(explode($separator, $name)); - $action = array_shift($parts); - foreach ($parts as $part) { - $action .= ucwords(strtolower($part)); - } - - if ($protected) { - return $action; - } - - $method = $action . 'Action'; - if (!method_exists($this, $method)) { - throw new Exception("Action '$name' is not found."); - } - return $method; - } - - /** - * @return Site - */ - public function getSite() { - return $this->site; - } - - public function getDB() { - return $this->fdb; - } - - protected function registerCSS($files, $name) { - $this->addFiles($files, $name, 'css'); - } - - protected function registerJS($files, $name) { - $this->addFiles($files, $name, 'js'); - } - - private function addFiles($files, $name, $type) { - if (!$files || !in_array($type, array('js', 'css'))) { - return; - } - if (!is_array($files)) { - $files = array($files); - } - foreach (array_filter($files) as $file) { - if (!isset($this->{$type}[$name])) { - $this->{$type}[$name] = array(); - } - $this->{$type}[$name][] = $file; - } - } - - protected function registerAssets($which) { - $assets = get_assets(); - if (!is_array($which)) { - $which = array($which); - } - foreach ($which as $asset) { - $this->registerCSS(array_val($assets[$asset], 'css'), $asset); - $this->registerJS(array_val($assets[$asset], 'js'), $asset); - } - } - - protected function unregisterAssets($which) { - if (is_array($which)) { - foreach ($which as $a) { - $this->unregisterAssets($a); - } - } - if (isset($this->css[$which])) { - unset($this->css[$which]); - } - if (isset($this->js[$which])) { - unset($this->js[$which]); - } - } - - protected function replaceAssets($old, $new, $module = 'site') { - $assets = get_default_assets($module); - foreach ($assets as $i => $asset) { - if ($asset === $old) { - $assets[$i] = $new; - } - } - $this->css = $this->js = array(); - $this->registerAssets($assets); - } - - protected function generateMetaInfo() { - $meta = array( - 'head_title' => $this->site->makeTitle(), - 'title' => 'formr - an online survey framework with live feedback', - 'description' => 'formr survey framework. chain simple surveys into long runs, use the power of R to generate pretty feedback and complex designs', - 'keywords' => 'formr, online survey, R software, opencpu, live feedback', - 'author' => 'formr.org', - 'url' => site_url(), - 'image' => asset_url('build/img/formr-og.png'), - ); - - return $meta; - } - - public function errorAction($code = null, $text = null) { - formr_error($code, $text); - } + /** + * + * @var Site + */ + protected $site; + + /** + * + * @var User + */ + protected $user; + + /** + * + * @var Run + */ + public $run; + + /** + * + * @var DB + */ + protected $fdb; + + /** + * + * @var SurveyStudy + */ + public $study; + + /** + * + * @var Request + */ + protected $request; + + /** + * @var Response + */ + protected $response; + + /** + * @var View + */ + protected $view; + + protected $css = array(); + protected $js = array(); + protected $vars = array(); + + public function __construct(Site &$site) { + /** @todo do these with dependency injection */ + global $user, $run, $study, $css, $js; + $this->site = $site; + $this->user = &$user; + $this->study = $study; + $this->run = $run; + if (is_array($css)) { + $this->css = $css; + } + if (is_array($js)) { + $this->js = $js; + } + + $this->fdb = DB::getInstance(); + $this->request = $site->request; + $this->response = new Response(); + } + + protected function setView($template, $vars = array()) { + $global = array( + 'site' => $this->site, + 'user' => $this->user, + 'fdb' => $this->fdb, + 'js' => $this->js, + 'css' => $this->css, + 'run' => $this->run, + 'study' => $this->study, + 'meta' => $this->generateMetaInfo(), + 'jsConfig' => $this->getJsConfig(), + ); + + $variables = array_merge($global, $this->vars, $vars); + $this->view = new View($template, $variables); + } + + protected function sendResponse($content = null) { + if ($content === null && $this->view) { + $content = $this->view->render(); + } + if ($content !== null) { + $this->response->setContent($content); + } + + $this->response->send(); + } + + protected function getPrivateAction($name, $separator = '_', $protected = false) { + $parts = array_filter(explode($separator, $name)); + $action = array_shift($parts); + foreach ($parts as $part) { + $action .= ucwords(strtolower($part)); + } + + if ($protected) { + return $action; + } + + $method = $action . 'Action'; + if (!method_exists($this, $method)) { + throw new Exception("Action '$name' is not found."); + } + + $disabledFeatures = Config::get('disabled_features', array()); + if (in_array('SURVEY.'.$method, $disabledFeatures) || in_array('RUN.'.$method, $disabledFeatures)) { + formr_error_feature_unavailable(); + } + + + return $method; + } + + /** + * @return Site + */ + public function getSite() { + return $this->site; + } + + public function getDB() { + return $this->fdb; + } + + protected function registerCSS($files, $name) { + $this->addFiles($files, $name, 'css'); + } + + protected function registerJS($files, $name) { + $this->addFiles($files, $name, 'js'); + } + + private function addFiles($files, $name, $type) { + if (!$files || !in_array($type, array('js', 'css'))) { + return; + } + if (!is_array($files)) { + $files = array($files); + } + foreach (array_filter($files) as $file) { + if (!isset($this->{$type}[$name])) { + $this->{$type}[$name] = array(); + } + $this->{$type}[$name][] = $file; + } + } + + protected function registerAssets($which) { + $assets = get_assets(); + if (!is_array($which)) { + $which = array($which); + } + foreach ($which as $asset) { + $this->registerCSS(array_val($assets[$asset], 'css'), $asset); + $this->registerJS(array_val($assets[$asset], 'js'), $asset); + } + } + + protected function unregisterAssets($which) { + if (is_array($which)) { + foreach ($which as $a) { + $this->unregisterAssets($a); + } + } + if (isset($this->css[$which])) { + unset($this->css[$which]); + } + if (isset($this->js[$which])) { + unset($this->js[$which]); + } + } + + protected function replaceAssets($old, $new, $module = 'site') { + $assets = get_default_assets($module); + foreach ($assets as $i => $asset) { + if ($asset === $old) { + $assets[$i] = $new; + } + } + $this->css = $this->js = array(); + $this->registerAssets($assets); + } + + protected function generateMetaInfo() { + $meta = array( + 'head_title' => $this->site->makeTitle(), + 'title' => 'formr - an online survey framework with live feedback', + 'description' => 'formr survey framework. chain simple surveys into long runs, use the power of R to generate pretty feedback and complex designs', + 'keywords' => 'formr, online survey, R software, opencpu, live feedback', + 'author' => 'formr.org', + 'url' => site_url(), + 'image' => asset_url('build/img/formr-og.png'), + ); + + return $meta; + } + + protected function getJsConfig() { + // Initialize JS config + $config = array(); + // URLs + $config['site_url'] = site_url(); + $config['admin_url'] = admin_url(); + // Cookie consent + $cookieconsent = Site::getSettings('js:cookieconsent', '{}'); + if ($cookieconsent && ($decoded = json_decode($cookieconsent, true))) { + $config['cookieconsent'] = $decoded; + } + + return $config; + } + + public function errorAction($code = null, $text = null) { + formr_error($code, $text); + } } diff --git a/application/Controller/PublicController.php b/application/Controller/PublicController.php index 2142ebc52..cff251304 100644 --- a/application/Controller/PublicController.php +++ b/application/Controller/PublicController.php @@ -1,213 +1,99 @@ registerAssets($default_assets); - } - } - public function indexAction() { - $this->renderView('public/home'); - } - - public function documentationAction() { - $this->renderView('public/documentation'); - } - - public function studiesAction() { - $this->renderView('public/studies', array('runs' => $this->user->getAvailableRuns())); - } - - public function aboutAction() { - $this->renderView('public/about', array('bodyClass' => 'fmr-about')); - } - - public function publicationsAction() { - $this->renderView('public/publications'); - } - - public function accountAction() { - /** - * @todo: - * - allow changing email address - * - email address verification - * - my access code has been compromised, reset? possible problems with external data, maybe they should get their own tokens... - */ - - if(!$this->user->loggedIn()) { - alert('You need to be logged in to go here.', 'alert-info'); - redirect_to('login'); - } - - $vars = array('showform' => false); - if($this->request->isHTTPPostRequest()) { - $redirect = false; - $oldEmail = $this->user->email; - - // Change basic info + email - $change = $this->user->changeData($this->request->str('password'), $this->request->getParams()); - if (!$change) { - alert(nl2br(implode($this->user->errors, "\n")), 'alert-danger'); - $vars['showform'] = 'show-form'; - } elseif ($oldEmail != $this->request->str('new_email')) { - $redirect = 'logout'; - } - - // Change password - if($this->request->str('new_password')) { - if ($this->request->str('new_password') !== $this->request->str('new_password_c')) { - alert('The new passwords do not match', 'alert-danger'); - $vars['showform'] = 'show-form'; - } elseif($this->user->changePassword($this->request->str('password'), $this->request->str('new_password'))) { - alert('Success! Your password was changed! Please sign-in with your new password.', 'alert-success'); - $redirect = 'logout'; - } else { - alert(implode($this->user->errors), 'alert-danger'); - $vars['showform'] = 'show-form'; - } - } - - if($redirect) { - redirect_to($redirect); - } - } - - $vars['user'] = $this->user; - $vars['joined'] = date('jS F Y', strtotime($this->user->created)); - $vars['studies'] = $this->fdb->count('survey_runs', array('user_id' => $this->user->id)); - $vars['names'] = sprintf('%s %s', $this->user->first_name, $this->user->last_name); - if ('' === trim($vars['names'])) { - $vars['names'] = $this->user->email; - } - $vars['affiliation'] = $this->user->affiliation ? $this->user->affiliation : '(no affiliation specified)'; - - $this->registerAssets('bootstrap-material-design'); - $this->renderView('public/account', $vars); - } - - public function loginAction() { - if($this->user->loggedIn()) { - redirect_to('account'); - } - - if($this->request->str('email') && $this->request->str('password')) { - if($this->user->login($this->request->str('email'), $this->request->str('password'))) { - alert('Success! You were logged in!', 'alert-success'); - Session::set('user', serialize($this->user)); - $redirect = $this->user->isAdmin() ? redirect_to('admin') : redirect_to('account'); - } else { - alert(implode($this->user->errors), 'alert-danger'); - } - } - - $this->registerAssets('bootstrap-material-design'); - $this->renderView('public/login', array('alerts' => $this->site->renderAlerts())); - } - - public function logoutAction() { - $user = $this->user; - if($user->loggedIn()) { - alert('You have been logged out!', 'alert-info'); - $alerts = $this->site->renderAlerts(); - $user->logout(); - $this->registerAssets('bootstrap-material-design'); - $this->renderView('public/login', array('alerts' => $alerts)); - } else { - Session::destroy(); - $redirect_to = $this->request->getParam('_rdir'); - redirect_to($redirect_to); - } - } - - public function registerAction() { - $user = $this->user; - $site = $this->site; - - //fixme: cookie problems lead to fatal error with missing user code - if($user->loggedIn()) { - alert('You were already logged in. Please logout before you can register.', 'alert-info'); - redirect_to("index"); - } - - if($this->request->isHTTPPostRequest() && $site->request->str('email')) { - if($user->register($site->request->str('email'), $site->request->str('password'), $site->request->str('referrer_code'))) { - //alert('Success! You were registered and logged in!','alert-success'); - redirect_to('index'); - } else { - alert(implode($user->errors),'alert-danger'); - } - } - - $this->registerAssets('bootstrap-material-design'); - $this->renderView('public/register'); - } - - public function verifyEmailAction() { - $user = $this->user; - $verification_token = $this->request->str('verification_token'); - $email = $this->request->str('email'); - - if ($this->request->isHTTPGetRequest() && $this->request->str('token')) { - $user->resendVerificationEmail($this->request->str('token')); - redirect_to('login'); - } elseif (!$verification_token || !$email) { - alert("You need to follow the link you received in your verification mail."); - redirect_to('login'); - } else { - $user->verify_email($email, $verification_token); - redirect_to('login'); - }; - } - - public function forgotPasswordAction() { - if($this->user->loggedIn()) { - redirect_to("index"); - } - - if($this->request->str('email')) { - $this->user->forgot_password($this->request->str('email')); - } - - $this->registerAssets('bootstrap-material-design'); - $this->renderView('public/forgot_password'); - } - - public function resetPasswordAction() { - $user = $this->user; - if($user->loggedIn()) { - redirect_to('index'); - } - - if ($this->request->isHTTPGetRequest() && (!$this->request->str('email') || !$this->request->str('reset_token')) && !$this->request->str('ok')) { - alert('You need to follow the link you received in your password reset mail'); - redirect_to('forgot_password'); - } elseif ($this->request->isHTTPPostRequest()) { - $postRequest = new Request($_POST); - $email = $postRequest->str('email'); - $token = $postRequest->str('reset_token'); - $newPass = $postRequest->str('new_password'); - $newPassOK = $postRequest->str('new_password_c'); - if (($done = $user->reset_password($email, $token, $newPass, $newPassOK))) { - redirect_to('forgot_password'); - } - } - - $this->registerAssets('bootstrap-material-design'); - $this->renderView('public/reset_password', array( - 'reset_data_email' => $this->request->str('email'), - 'reset_data_token' => $this->request->str('reset_token'), - )); - } - - public function fileDownloadAction($run_id = 0, $original_filename = '') { - $path = $this->fdb->findValue('survey_uploaded_files', array('run_id' => (int)$run_id, 'original_file_name' => $original_filename), array('new_file_path')); - if ($path) { - return redirect_to(asset_url($path)); - } - formr_error(404, 'Not Found', 'The requested file does not exist'); - } + public function __construct(Site &$site) { + parent::__construct($site); + if (!Request::isAjaxRequest()) { + $default_assets = get_default_assets('site'); + $this->registerAssets($default_assets); + } + } + + public function indexAction() { + $this->setView('public/home'); + return $this->sendResponse(); + } + + public function documentationAction() { + if (Site::getSettings('content:docu:show', 'true') !== 'true') { + formr_error(403, 'Not Public', 'Page cannot be displayed'); + } + $this->setView('public/documentation', array('headerClass' => 'fmr-small-header')); + return $this->sendResponse(); + } + + public function studiesAction() { + if (Site::getSettings('content:studies:show', 'true') !== 'true') { + formr_error(403, 'Not Public', 'Page cannot be displayed'); + } + + $this->setView('public/studies', array('runs' => RunHelper::getPublicRuns())); + return $this->sendResponse(); + } + + public function aboutAction() { + if (Site::getSettings('content:about:show', 'true') !== 'true') { + formr_error(403, 'Not Public', 'Page cannot be displayed'); + } + + $this->setView('public/about', array( + 'bodyClass' => 'fmr-about', + 'headerClass' => 'fmr-small-header' + )); + return $this->sendResponse(); + } + + public function publicationsAction() { + if (Site::getSettings('content:publications:show', 'true') !== 'true') { + formr_error(403, 'Not Public', 'Page cannot be displayed'); + } + + $this->setView('public/publications', array('headerClass' => 'fmr-small-header')); + return $this->sendResponse(); + } + + public function loginAction() { + $this->request->redirect('admin/account/login'); + } + + public function logoutAction() { + $this->request->redirect('admin/account/logout'); + } + + public function registerAction() { + $this->request->redirect('admin/account/register'); + } + + public function accountAction() { + $this->request->redirect('admin/account'); + } + + public function resetPasswordAction() { + $this->request->redirect('admin/account/reset-password', array( + 'email' => $this->request->str('email'), + 'reset_token' => $this->request->str('reset_token'), + )); + } + + public function forgotPasswordAction() { + $this->request->redirect('admin/account/forgot-password'); + } + + public function verifyEmailAction() { + $this->request->redirect('admin/account/verify-email', array( + 'email' => $this->request->str('email'), + 'verification_token' => $this->request->str('verification_token'), + 'token' => $this->request->str('token', null), + )); + } + + public function fileDownloadAction($run_id = 0, $original_filename = '') { + $path = $this->fdb->findValue('survey_uploaded_files', array('run_id' => (int) $run_id, 'original_file_name' => $original_filename), array('new_file_path')); + if ($path) { + return $this->request->redirect(asset_url($path)); + } + formr_error(404, 'Not Found', 'The requested file does not exist'); + } } diff --git a/application/Controller/RunController.php b/application/Controller/RunController.php index ab9ec2955..b78e532d6 100644 --- a/application/Controller/RunController.php +++ b/application/Controller/RunController.php @@ -2,200 +2,285 @@ class RunController extends Controller { - public function __construct(Site &$site) { - parent::__construct($site); - if (!Request::isAjaxRequest()) { - $default_assets = get_default_assets('site'); - $this->registerAssets($default_assets); - } - } - - public function indexAction($runName = '', $privateAction = null) { - // hack for run name - $_GET['run_name'] = $runName; - $this->site->request->run_name = $runName; - $pageNo = null; - - if ($method = $this->getPrivateActionMethod($privateAction)) { - $args = array_slice(func_get_args(), 2); - return call_user_func_array(array($this, $method), $args); - } elseif (is_numeric($privateAction)) { - $pageNo = (int) $privateAction; - Request::setGlobals('pageNo', $pageNo); - } elseif ($privateAction !== null) { - formr_error(404, 'Not Found', 'The requested URL was not found'); - } + public function __construct(Site &$site) { + + parent::__construct($site); + if (!Request::isAjaxRequest()) { + $default_assets = get_default_assets('site'); + $this->registerAssets($default_assets); + } + } - $this->user = $this->site->loginUser($this->user); - $this->run = $this->getRun(); - $run_vars = $this->run->exec($this->user); - $run_vars['bodyClass'] = 'fmr-run'; + public function indexAction($runName = '', $privateAction = null) { + // hack for run name + $_GET['run_name'] = $runName; + $this->site->request->run_name = $runName; + $pageNo = null; - $assset_vars = $this->filterAssets($run_vars); - unset($run_vars['css'], $run_vars['js']); - $this->renderView('public/run/index', array_merge($run_vars, $assset_vars)); - } + if ($method = $this->getPrivateActionMethod($privateAction)) { + $args = array_slice(func_get_args(), 2); + return call_user_func_array(array($this, $method), $args); + } elseif (is_numeric($privateAction)) { + $pageNo = (int) $privateAction; + Request::setGlobals('pageNo', $pageNo); + } elseif ($privateAction !== null) { + formr_error(404, 'Not Found', 'The requested URL was not found'); + } - protected function settingsAction() { - $run = $this->getRun(); - $run_name = $this->site->request->run_name; + $this->run = $this->getRun(); + // @todo check the POSTed code ($_POST[formr_code]) and save data before redirecting + // OR if cookie is expired then logout + $this->user = $this->loginUser(); - if (!$run->valid) { - formr_error(404, 'Not Found', 'Requested Run does not exist or has been moved'); - } + //Request::setGlobals('COOKIE', $this->setRunCookie()); - // Login if user entered with code and redirect without login code - if (Request::isHTTPGetRequest() && ($code = $this->request->getParam('code'))) { - $_GET['run_name'] = $run_name; - $this->user = $this->site->loginUser($this->user); - if ($this->user->user_code != $code) { - alert('Unable to login with the provided code', 'alert-warning'); - } - redirect_to(run_url($run_name, 'settings')); + $run_vars = $this->run->exec($this->user); + if (!$run_vars) { + formr_error(500, 'Invalid Execution', 'The execution generated no output'); } + + $run_vars['bodyClass'] = 'fmr-run'; + + if (!empty($run_vars['redirect'])) { + return $this->request->redirect($run_vars['redirect']); + } - // People who have no session in the run need not set anything - $session = new RunSession($this->fdb, $run->id, 'cron', $this->user->user_code, $run); - if (!$session->id) { - formr_error(401, 'Unauthorized', 'You cannot create settings in a study you have not participated in.'); - } + $assset_vars = $this->filterAssets($run_vars); + unset($run_vars['css'], $run_vars['js']); - $settings = array('no_email' => 1); - if (Request::isHTTPPostRequest() && $this->user->user_code == $this->request->getParam('_sess')) { - $update = array(); - $settings = array( - 'no_email' => $this->request->getParam('no_email'), - 'delete_cookie' => (int)$this->request->getParam('delete_cookie'), - ); - - if ($settings['no_email'] === '1') { - $update['no_email'] = null; - } elseif ($settings['no_email'] == 0) { - $update['no_email'] = 0; - } elseif ($ts = strtotime($settings['no_email'])) { - $update['no_email'] = $ts; - } - - $session->saveSettings($settings, $update); - - alert('Settings saved successfully for survey "'.$run->name.'"', 'alert-success'); - if ($settings['delete_cookie']) { - Session::destroy(); - redirect_to('index'); - } - redirect_to(run_url($run_name, 'settings')); - } + $this->setView('run/index', array_merge($run_vars, $assset_vars)); - $this->run = $run; - $this->renderView('public/run/settings', array( - 'settings' => $session->getSettings(), - 'email_subscriptions' => Config::get('email_subscriptions'), - )); - } - - protected function logoutAction() { - $run = $this->getRun(); - Session::destroy(); - $hint = 'Session Ended'; - $text = 'Your session was successfully closed! You can restart a new session by clicking the link below.'; - formr_error(200, 'OK', $text, $hint, run_url($run->name), 'Start New Session'); - } - - protected function monkeyBarAction($action = '') { - $action = str_replace('ajax_', '', $action); - $allowed_actions = array('send_to_position', 'remind', 'next_in_run', 'delete_user', 'snip_unit_session'); - $run = $this->getRun(); - - if (!in_array($action, $allowed_actions) || !$run->valid) { - throw new Exception("Invalid Request parameters"); - } + return $this->sendResponse(); + } - $parts = explode('_', $action); - $method = array_shift($parts) . str_replace(' ', '', ucwords(implode(' ', $parts))); - $runHelper = new RunHelper($this->request, $this->fdb, $run->name); + protected function settingsAction() { + $run = $this->getRun(); + $run_name = $this->site->request->run_name; - // check if run session usedby the monkey bar is a test if not this action is not valid - if (!($runSession = $runHelper->getRunSession()) || !$runSession->isTesting()) { - throw new Exception ("Unauthorized access to run session"); - } + if (!$run->valid) { + formr_error(404, 'Not Found', 'Requested Run does not exist or has been moved'); + } - if (!method_exists($runHelper, $method)) { - throw new Exception("Invalid method {$action}"); - } + // Login if user entered with code and redirect without login code + if (Request::isHTTPGetRequest() && ($code = $this->request->getParam('code'))) { + $_GET['run_name'] = $run_name; + $this->user = $this->loginUser(); + //Request::setGlobals('COOKIE', $this->setRunCookie()); - $runHelper->{$method}(); - if (($errors = $runHelper->getErrors())) { - $errors = implode("\n", $errors); - alert($errors, 'alert-danger'); - } + if ($this->user->user_code != $code) { + alert('Unable to login with the provided code', 'alert-warning'); + } + $this->request->redirect(run_url($run_name, 'settings')); + } - if (($message = $runHelper->getMessage())) { - alert($message, 'alert-info'); - } + // People who have no session in the run need not set anything + $session = new RunSession($this->user->user_code, $run); + if (!$session->id) { + formr_error(401, 'Unauthorized', 'You cannot create settings in a study you have not participated in.'); + } - if (is_ajax_request()) { - echo $this->site->renderAlerts(); - exit; - } - redirect_to(''); - } - - private function getRun() { - $name = $this->request->str('run_name'); - $run = new Run($this->fdb, $name); - if ($name !== Run::TEST_RUN && Config::get('use_study_subdomains') && !FMRSD_CONTEXT) { - //throw new Exception('Invalid Study Context'); - // Redirect existing users to run's sub-domain URL and QSA - $params = $this->request->getParams(); - unset($params['route'], $params['run_name']); - $name = str_replace('_', '-', $name); - $url = run_url($name, null, $params); - redirect_to($url); - } elseif (!$run->valid) { - $msg = __('If you\'re trying to create an online study, read the full documentation to learn how to create one.', site_url('documentation')); - formr_error(404, 'Not Found', $msg, 'There isn\'t an online study here.'); - } + $settings = array('no_email' => 1); + if (Request::isHTTPPostRequest() && $this->user->user_code == $this->request->getParam('_sess')) { + $update = array(); + $settings = array( + 'no_email' => $this->request->getParam('no_email'), + 'delete_cookie' => (int) $this->request->getParam('delete_cookie'), + ); - return $run; - } + if ($settings['no_email'] === '1') { + $update['no_email'] = null; + } elseif ($settings['no_email'] == 0) { + $update['no_email'] = 0; + } elseif ($ts = strtotime($settings['no_email'])) { + $update['no_email'] = $ts; + } - private function getPrivateActionMethod($action) { - $actionName = $this->getPrivateAction($action, '-', true) . 'Action'; - if (!method_exists($this, $actionName)) { - return false; - } - return $actionName; - } - - private function filterAssets($assets) { - $vars = array(); - if ($this->run->use_material_design === true || $this->request->str('tmd') === 'true') { - if (DEBUG) { - $this->unregisterAssets('site:custom'); - $this->registerAssets('bootstrap-material-design'); - $this->registerAssets('site:custom'); - } else { - $this->replaceAssets('site', 'site:material'); - } - $vars['bodyClass'] = 'bs-material fmr-run'; - } - $this->registerCSS($assets['css'], $this->run->name); - $this->registerJS($assets['js'], $this->run->name); - return $vars; - } - - protected function generateMetaInfo() { - $meta = parent::generateMetaInfo(); - $meta['title'] = $this->run->title ? $this->run->title : $this->run->name; - $meta['url'] = run_url($this->run->name); - if ($this->run->description) { - $meta['description'] = $this->run->description; - } - if ($this->run->header_image_path) { - $meta['image'] = $this->run->header_image_path; - } + $session->saveSettings($settings, $update); + + alert('Settings saved successfully for survey "' . $run->name . '"', 'alert-success'); + if ($settings['delete_cookie']) { + Session::destroy(); + $this->request->redirect('index'); + } + $this->request->redirect(run_url($run_name, 'settings')); + } + + $this->run = $run; + $this->setView('run/settings', array( + 'settings' => $session->getSettings(), + 'email_subscriptions' => Config::get('email_subscriptions'), + )); + + return $this->sendResponse(); + } + + protected function logoutAction() { + $this->run = $this->getRun(); + $this->user = $this->loginUser(); + $cookie = $this->getRunCookie(); + $cookie->destroy(); + Session::destroy(false); + $hint = 'Session Ended'; + $text = 'Your session was successfully closed! You can restart a new session by clicking the link below.'; + $url = run_url($this->run->name); + if ($this->request->prev) { + //If user is loggin out from a test session, show button to create another test session + $prevRunSesson = new RunSession($this->request->prev, $this->run); + if ($prevRunSesson->testing) { + $url = admin_run_url($this->run->name, 'create_new_test_code'); + } + } + formr_error(200, 'OK', $text, $hint, $url, 'Start New Session'); + } + + protected function monkeyBarAction($action = '') { + $action = str_replace('ajax_', '', $action); + $allowed_actions = array('send_to_position', 'remind', 'next_in_run', 'delete_user', 'snip_unit_session'); + $run = $this->getRun(); + + if (!in_array($action, $allowed_actions) || !$run->valid) { + throw new Exception("Invalid Request parameters"); + } + + $parts = explode('_', $action); + $method = array_shift($parts) . str_replace(' ', '', ucwords(implode(' ', $parts))); + $runHelper = new RunHelper($run, $this->fdb, $this->request); + + // check if run session usedby the monkey bar is a test if not this action is not valid + if (!($runSession = $runHelper->getRunSession()) || !$runSession->isTesting()) { + throw new Exception("Unauthorized access to run session"); + } + + if (!method_exists($runHelper, $method)) { + throw new Exception("Invalid method {$action}"); + } + + $runHelper->{$method}(); + + if (($errors = $runHelper->getErrors())) { + $errors = implode("\n", $errors); + alert($errors, 'alert-danger'); + } + + if (($message = $runHelper->getMessage())) { + alert($message, 'alert-info'); + } + + if (Request::isAjaxRequest()) { + $content = $this->site->renderAlerts(); + $this->sendResponse($content); + } else { + $this->request->redirect(''); + } + } + + private function getRun() { + $name = $this->request->str('run_name'); + $run = new Run($name); + if ($name !== Run::TEST_RUN && Config::get('use_study_subdomains') && !FMRSD_CONTEXT) { + //throw new Exception('Invalid Study Context'); + // Redirect existing users to run's sub-domain URL and QSA + $params = $this->request->getParams(); + unset($params['route'], $params['run_name']); + $name = str_replace('_', '-', $name); + $url = run_url($name, null, $params); + $this->request->redirect($url); + } elseif (!$run->valid) { + $msg = __('If you\'re trying to create an online study, read the full documentation to learn how to create one.', site_url('documentation')); + formr_error(404, 'Not Found', $msg, 'There isn\'t an online study here.'); + } + + return $run; + } + + private function getPrivateActionMethod($action) { + if ($action === null) { + return false; + } + + $actionName = $this->getPrivateAction($action, '-', true) . 'Action'; + if (!method_exists($this, $actionName)) { + return false; + } + return $actionName; + } + + private function filterAssets($assets) { + $vars = array(); + if ($this->run->use_material_design === true || $this->request->str('tmd') === 'true') { + if (DEBUG) { + $this->unregisterAssets('site:custom'); + $this->registerAssets('bootstrap-material-design'); + $this->registerAssets('site:custom'); + } else { + $this->replaceAssets('site', 'site:material'); + } + $vars['bodyClass'] = 'bs-material fmr-run'; + } + $this->registerCSS($assets['css'], $this->run->name); + $this->registerJS($assets['js'], $this->run->name); + return $vars; + } + + protected function generateMetaInfo() { + $meta = parent::generateMetaInfo(); + $meta['title'] = $this->run->title ? $this->run->title : $this->run->name; + $meta['url'] = run_url($this->run->name); + if ($this->run->description) { + $meta['description'] = $this->run->description; + } + if ($this->run->header_image_path) { + $meta['image'] = $this->run->header_image_path; + } + + return $meta; + } + + protected function setRunCookie($refresh = false) { + $cookie = $this->getRunCookie(); + $expires = $this->run->expire_cookie ? time() + $this->run->expire_cookie : 0; + + if (!$cookie->exists() || $refresh === true) { + $data = array( + 'code' => $this->user->user_code, + 'created' => time(), + 'modified' => time(), + 'expires' => $expires, + ); + $cookie->create($data, $expires, '/', null, SSL, true); + } elseif ($cookie->exists()) { + $cookie->setExpiration($expires); + } + + return $cookie; + } + + /** + * + * @return \Cookie + */ + protected function getRunCookie() { + $cookie = new \Cookie($this->run->getCookieName()); + return $cookie; + } + + protected function loginUser() { + $id = null; - return $meta; - } + // came here with a login link + if (isset($_GET['run_name']) && isset($_GET['code']) && strlen($_GET['code']) == 64) { + // user came in with login code + $loginCode = $_GET['code']; + } elseif ($user = Site::getInstance()->getSessionUser()) { + // try to get user from cookie + $loginCode = $user->user_code; + $id = $user->id; + } else { + // new user just entering the run; + $loginCode = null; + } + + return new User($id, $loginCode); + } } diff --git a/application/Controller/SuperadminController.php b/application/Controller/SuperadminController.php deleted file mode 100644 index eb4c643fb..000000000 --- a/application/Controller/SuperadminController.php +++ /dev/null @@ -1,339 +0,0 @@ -user->isSuperAdmin()) { - alert('You do not have sufficient rights to access the requested location', 'alert-danger'); - redirect_to('admin'); - } - if (!Request::isAjaxRequest()) { - $default_assets = get_default_assets('admin'); - $this->registerAssets($default_assets); - } - } - - public function indexAction() { - redirect_to('/'); - } - - public function ajaxAdminAction() { - if (!is_ajax_request()) { - return redirect_to('/'); - } - - $request = new Request($_POST); - if ($request->user_id && is_numeric($request->admin_level)) { - $this->setAdminLevel($request->user_id, $request->admin_level); - } - - if ($request->user_api) { - $this->apiUserManagement($request->user_id, $request->user_email, $request->api_action); - } - } - - private function setAdminLevel($user_id, $level) { - $level = (int) $level; - $allowed_levels = array(0, 1, 100); - $user = new User($this->fdb, $user_id, null); - - if (!in_array($level, $allowed_levels) || !$user->email) { - alert('Level not supported or could not be assigned to user', 'alert-danger'); - } elseif ($level == $user->getAdminLevel()) { - alert('User already has requested admin rights', 'alert-warning'); - } else { - if (!$user->setAdminLevelTo($level)) : - alert('Something went wrong with the admin level change.', 'alert-danger'); - bad_request_header(); - else: - alert('Level assigned to user.', 'alert-success'); - endif; - } - - echo $this->site->renderAlerts(); - exit; - } - - private function apiUserManagement($user_id, $user_email, $action) { - $user = new User($this->fdb, $user_id, null); - $response = new Response(); - $response->setContentType('application/json'); - if ($user->email !== $user_email) { - $response->setJsonContent(array('success' => false, 'message' => 'Invalid User')); - } elseif ($action === 'create') { - $client = OAuthHelper::getInstance()->createClient($user); - if (!$client) { - $response->setJsonContent(array('success' => false, 'message' => 'Unable to create client')); - } else { - $client['user'] = $user->email; - $response->setJsonContent(array('success' => true, 'data' => $client)); - } - } elseif ($action === 'get') { - $client = OAuthHelper::getInstance()->getClient($user); - if (!$client) { - $response->setJsonContent(array('success' => true, 'data' => array('client_id' => '', 'client_secret' => '', 'user' => $user->email))); - } else { - $client['user'] = $user->email; - $response->setJsonContent(array('success' => true, 'data' => $client)); - } - } elseif ($action === 'delete') { - if (OAuthHelper::getInstance()->deleteClient($user)) { - $response->setJsonContent(array('success' => true, 'message' => 'Credentials revoked for user ' . $user->email)); - } else { - $response->setJsonContent(array('success' => false, 'message' => 'An error occured')); - } - } elseif ($action === 'change') { - $client = OAuthHelper::getInstance()->refreshToken($user); - if (!$client) { - $response->setJsonContent(array('success' => false, 'message' => 'An error occured refereshing API secret.')); - } else { - $client['user'] = $user->email; - $response->setJsonContent(array('success' => true, 'data' => $client)); - } - } - - $response->send(); - } - - public function cronLogParsed() { - $parser = new LogParser(); - $files = $parser->getCronLogFiles(); - $file = $this->request->getParam('f'); - $expand = $this->request->getParam('e'); - $parse = null; - if ($file && isset($files[$file])) { - $parse = $file; - } - - $this->renderView('superadmin/cron_log_parsed', array( - 'files' => $files, - 'parse' => $parse, - 'parser' => $parser, - 'expand_logs' => $expand, - )); - } - - public function cronLogAction() { - return $this->cronLogParsed(); - // @todo: deprecate code - $cron_entries_count = $this->fdb->count('survey_cron_log'); - $pagination = new Pagination($cron_entries_count); - $limits = $pagination->getLimits(); - - $cron_entries_query = "SELECT - `survey_cron_log`.id, - `survey_users`.email, - `survey_cron_log`.run_id, - `survey_cron_log`.created, - `survey_cron_log`.ended - `survey_cron_log`.created AS time_in_seconds, - `survey_cron_log`.sessions, - `survey_cron_log`.skipbackwards, - `survey_cron_log`.skipforwards, - `survey_cron_log`.pauses, - `survey_cron_log`.emails, - `survey_cron_log`.shuffles, - `survey_cron_log`.errors, - `survey_cron_log`.warnings, - `survey_cron_log`.notices, - `survey_cron_log`.message, - `survey_runs`.name AS run_name - FROM `survey_cron_log` LEFT JOIN `survey_runs` ON `survey_cron_log`.run_id = `survey_runs`.id - LEFT JOIN `survey_users` ON `survey_users`.id = `survey_runs`.user_id - ORDER BY `survey_cron_log`.id DESC LIMIT $limits;"; - - $g_cron = $this->fdb->execute($cron_entries_query, array('user_id', $this->user->id)); - $cronlogs = array(); - foreach ($g_cron as $cronlog) { - $cronlog = array_reverse($cronlog, true); - $cronlog['Modules'] = ''; - - if ($cronlog['pauses'] > 0) - $cronlog['Modules'] .= $cronlog['pauses'] . ' '; - if ($cronlog['skipbackwards'] > 0) - $cronlog['Modules'] .= $cronlog['skipbackwards'] . ' '; - if ($cronlog['skipforwards'] > 0) - $cronlog['Modules'] .= $cronlog['skipforwards'] . ' '; - if ($cronlog['emails'] > 0) - $cronlog['Modules'] .= $cronlog['emails'] . ' '; - if ($cronlog['shuffles'] > 0) - $cronlog['Modules'] .= $cronlog['shuffles'] . ' '; - $cronlog['Modules'] .= ''; - $cronlog['took'] = '' . round($cronlog['time_in_seconds'] / 60, 2) . 'm'; - $cronlog['time'] = '' . timetostr(strtotime($cronlog['created'])) . ''; - $cronlog['Run name'] = $cronlog['run_name']; - $cronlog['Owner'] = $cronlog['email']; - - $cronlog = array_reverse($cronlog, true); - unset($cronlog['run_name']); - unset($cronlog['created']); - unset($cronlog['time_in_seconds']); - unset($cronlog['skipforwards']); - unset($cronlog['skipbackwards']); - unset($cronlog['pauses']); - unset($cronlog['emails']); - unset($cronlog['shuffles']); - unset($cronlog['run_id']); - unset($cronlog['id']); - unset($cronlog['email']); - - $cronlogs[] = $cronlog; - } - - $this->renderView('superadmin/cron_log', array( - 'cronlogs' => $cronlogs, - 'pagination' => $pagination, - )); - } - - public function userManagementAction() { - $user_count = $this->fdb->count('survey_users'); - $pagination = new Pagination($user_count, 200, true); - $limits = $pagination->getLimits(); - - $users_query = "SELECT - `survey_users`.id, - `survey_users`.created, - `survey_users`.modified, - `survey_users`.email, - `survey_users`.admin, - `survey_users`.email_verified - FROM `survey_users` - ORDER BY `survey_users`.id ASC LIMIT $limits;"; - - $g_users = $this->fdb->prepare($users_query); - $g_users->execute(); - - $users = array(); - while($userx = $g_users->fetch(PDO::FETCH_ASSOC)) { - $userx['Email'] = ''.h($userx['email']).'' . ($userx['email_verified'] ? " ":" "); - $userx['Created'] = "".timetostr(strtotime($userx['created'])).""; - $userx['Modified'] = "".timetostr(strtotime($userx['modified'])).""; - $userx['Admin'] = " - "; - $userx['API Access'] = ''; - - unset($userx['email'], $userx['created'], $userx['modified'], $userx['admin'], $userx['id'], $userx['email_verified']); - - $users[] = $userx; - } - - $this->renderView('superadmin/user_management', array( - 'users' => $users, - 'pagination' => $pagination, - )); - } - - public function activeUsersAction() { - $user_count = $this->fdb->count('survey_users'); - $pagination = new Pagination($user_count, 200, true); - $limits = $pagination->getLimits(); - - $users_query = "SELECT - `survey_users`.id, - `survey_users`.created, - `survey_users`.modified, - `survey_users`.email, - `survey_users`.admin, - `survey_users`.email_verified, - `survey_runs`.name AS run_name, - `survey_runs`.cron_active, - `survey_runs`.public, - COUNT(`survey_run_sessions`.id) AS number_of_users_in_run, - MAX(`survey_run_sessions`.last_access) AS last_edit - FROM `survey_users` - LEFT JOIN `survey_runs` ON `survey_runs`.user_id = `survey_users`.id - LEFT JOIN `survey_run_sessions` ON `survey_runs`.id = `survey_run_sessions`.run_id - WHERE `survey_users`.admin > 0 - GROUP BY `survey_runs`.id - ORDER BY `survey_users`.id ASC, last_edit DESC LIMIT $limits;"; - - $g_users = $this->fdb->prepare($users_query); - $g_users->execute(); - - $users = array(); - $last_user = ""; - while($userx = $g_users->fetch(PDO::FETCH_ASSOC)) { - $public_status = (int)$userx['public']; - $public_logo = ''; - if($public_status===0): - $public_logo = "fa-eject"; - elseif($public_status === 1): - $public_logo = "fa-volume-off"; - elseif($public_status === 2): - $public_logo = "fa-volume-down"; - elseif($public_status === 3): - $public_logo = "fa-volume-up"; - endif; - if($last_user !== $userx['id']): - $userx['Email'] = ''.h($userx['email']).'' . ($userx['email_verified'] ? " ":" "); - $last_user = $userx['id']; - else: - $userx['Email'] = ''; - endif; - $userx['Created'] = "".timetostr(strtotime($userx['created'])).""; - $userx['Modified'] = "".timetostr(strtotime($userx['modified'])).""; - $userx['Run'] = h($userx['run_name'])." ". - ($userx['cron_active']? "":"").' ' . - ""; - $userx['Users'] = $userx['number_of_users_in_run']; - $userx['Last active'] = "".timetostr(strtotime($userx['last_edit'])).""; - - unset($userx['email']); - unset($userx['created']); - unset($userx['modified']); - unset($userx['admin']); - unset($userx['number_of_users_in_run']); - unset($userx['public']); - unset($userx['cron_active']); - unset($userx['run_name']); - unset($userx['id']); - unset($userx['last_edit']); - unset($userx['email_verified']); - # $user['body'] = "". substr($user['body'],0,50). "…"; - - $users[] = $userx; - } - - $this->renderView('superadmin/active_users', array( - 'users' => $users, - 'pagination' => $pagination, - )); - } - - public function runsManagementAction() { - if (Request::isHTTPPostRequest()) { - // process post request and redirect - foreach ($this->request->arr('runs') as $id => $data) { - $update = array( - 'cron_active' => (int)isset($data['cron_active']), - 'cron_fork' => (int)isset($data['cron_fork']), - 'locked' => (int)isset($data['locked']), - ); - $this->fdb->update('survey_runs', $update, array('id' => (int)$id)); - } - alert('Changes saved', 'alert-success'); - redirect_to('superadmin/runs_management'); - } - - $q = 'SELECT survey_runs.id AS run_id, name, survey_runs.user_id, cron_active, cron_fork, locked, count(survey_run_sessions.session) AS sessions, survey_users.email - FROM survey_runs - LEFT JOIN survey_users ON survey_users.id = survey_runs.user_id - LEFT JOIN survey_run_sessions ON survey_run_sessions.run_id = survey_runs.id - GROUP BY survey_run_sessions.run_id - ORDER BY survey_runs.name ASC - '; - $this->renderView('superadmin/runs_management', array( - 'runs' => $this->fdb->query($q), - 'i' => 1, - )); - } -} \ No newline at end of file diff --git a/application/Cookie.php b/application/Cookie.php new file mode 100644 index 000000000..ad8b95e81 --- /dev/null +++ b/application/Cookie.php @@ -0,0 +1,169 @@ +name = $name; + $clear = false; + + if ($file) { + $this->file = md5($file); + } elseif (isset($_COOKIE[$name])) { + $this->file = $_COOKIE[$name]; + } elseif (isset($_POST[self::REQUEST_NAME])) { + // Load cookie from POSTed data if browser cookie already expired + // to avoid data loss on submission + $this->file = $_POST[self::REQUEST_NAME]; + $clear = true; // cookie not sent by browser but by post request + $this->isBrowserCookie = false; + } else { + $this->file = md5(crypto_token(48)); + } + + $this->filename = APPLICATION_ROOT . 'tmp/sessions/sess_' . $this->file . '.json'; + if ($this->exists()) { + $this->data = $this->getData(); + } + if ($clear) { + //$this->deleteFile(); + } + } + + public function create($data, $expire = 0, $path = '/', $domain = null, $secure = false, $httponly = false) { + if (file_exists($this->filename)) { + unset($data['created'], $data['expires']); + return $this->saveData($data); + } + + $data['path'] = $path; + $data['domain'] = $domain; + $data['secure'] = $secure; + $data['httponly'] = $httponly; + + $this->saveData($data); + return $this->set($expire, $path, $domain, $secure, $httponly); + } + + public function saveData($data) { + if (!file_exists($this->filename) && !isset($data['expires'])) { + return; + } + + $this->data = array_merge($this->data, $data); + $this->data['modified'] = time(); + return file_put_contents($this->filename, json_encode($this->data, JSON_PRETTY_PRINT)); + } + + public function getData($field = null, $default = null) { + if (!$this->data && file_exists($this->filename)) { + $contents = file_get_contents($this->filename); + $this->data = @json_decode($contents, true); + } + + if ($field !== null) { + return array_val($this->data, $field, $default); + } else { + return $this->data; + } + } + + public function clearData() { + $this->data = array(); + } + + public function exists() { + return isset($_COOKIE[$this->name]) || isset($_POST[self::REQUEST_NAME]); + } + + public function set($expire = 0, $path = '/', $domain = null, $secure = false, $httponly = false) { + return setcookie($this->name, $this->file, $expire, $path, $domain, $secure, $httponly); + } + + public function destroy() { + setcookie($this->name, '', time() - 3600); + $this->deleteFile(); + } + + public function isExpired() { + if (empty($this->data['expires'])) { + return false; + } + + return $this->data['expires'] < time(); + } + + public function getRequestToken() { + $token = sha1(mt_rand()); + if (!$tokens = $this->getData(self::REQUEST_TOKENS)) { + $tokens = array($token => 1); + } else { + $tokens[$token] = 1; + } + + $this->saveData(array(self::REQUEST_TOKENS => $tokens)); + return $token; + } + + public function canValidateRequestToken(Request $request) { + $token = $request->getParam(self::REQUEST_TOKENS); + $tokens = $this->getData(self::REQUEST_TOKENS, array()); + //$cookie = $request->getParam(self::REQUEST_NAME); + $code = $request->getParam(self::REQUEST_USER_CODE); + $validated = false; + + if (!$this->isBrowserCookie) { + $validated = $code == $this->getData('code') && !empty($tokens[$token]); + error_log('Validated: ' . $validated); + error_log('POSTed cookie: ' . print_r($this->getData(), 1)); + } else { + $validated = !empty($tokens[$token]); + if ($validated) { + unset($tokens[$token]); + $this->saveData(array(self::REQUEST_TOKENS => $tokens)); + } + error_log('Browser cookie: ' . print_r($this->getData(), 1)); + } + + return $validated; + } + + public function getName() { + return $this->name; + } + + public function getFile() { + return $this->file; + } + + public function deleteFile() { + if (file_exists($this->filename)) { + @unlink($this->filename); + } + } + + public function setExpiration($timestamp) { + if (!file_exists($this->filename) || !$this->isBrowserCookie) { + return false; + } + + $path = $this->getData('path', '/'); + $domain = $this->getData('domain'); + $secure = $this->getData('secure', SSL); + $httponly = $this->getData('httponly', true); + $this->saveData(array('expires' => $timestamp)); + + return $this->set($timestamp, $path, $domain, $secure, $httponly); + } + +} diff --git a/application/Cron.php b/application/Cron.php new file mode 100644 index 000000000..77455ba26 --- /dev/null +++ b/application/Cron.php @@ -0,0 +1,243 @@ +db = $db; + $this->site = $site; + $this->user = $user; + $this->config = $config; + $this->lockfile = $params['lockfile']; + $this->logfile = $params['logfile']; + $this->process_run = $params['process_run']; + + $this->start_datastamp = date('r'); + + $this->setUp(); + } + + protected function setUp() { + // Check if lock exists and exit if it does to avoid running similar process + if ($this->lockExists()) { + exit(1); + } + + set_time_limit($this->config['ttl_cron']); + register_shutdown_function(array($this, 'cleanup')); + + // Register signal handlers that should be able to kill the cron in case some other weird stuff happens + // apart from cron exiting cleanly + // declare signal handlers + if (extension_loaded('pcntl')) { + declare(ticks = 1); + + pcntl_signal(SIGINT, array(&$this, 'interrupt')); + pcntl_signal(SIGTERM, array(&$this, 'interrupt')); + pcntl_signal(SIGUSR1, array(&$this, 'interrupt')); + } else { + $this->debug = true; + $this->dbg('pcntl extension is not loaded'); + } + } + + public function execute() { + if (!$this->lock()) { + $this->dbg('Unable to LOCK cron.. exiting'); + exit(1); + } + + /** Do the Work */ + $this->dbg(".... Cron started .... {$this->start_datastamp}"); + $start_time = microtime(true); + + if ($this->process_run) { + $this->executeRun($this->process_run); + } else { + $this->executeList(); + } + + $minutes = round((microtime(true) - $start_time) / 60, 3); + $end_date = date('r'); + $this->dbg(".... Cron ended .... {$end_date}. Took ~{$minutes} minutes"); + + $this->unLock(); + $this->cleanup(); + } + + protected function executeList() { + try { + // Get all runs + $runs = $this->db->select('name')->from('survey_runs')->where('cron_active = 1')->order('cron_fork', 'DESC')->fetchAll(); + + foreach ($runs as $run_data) { + $run = new Run($run_data['name']); + if (!$run->valid) { + alert("This run '{$run_data['name']}' caused problems", 'alert-danger'); + continue; + } + + // If run is locked, do not process it + $lockfile = APPLICATION_ROOT . "tmp/cron-{$run->name}.lock"; + if ($this->lockExists($lockfile)) { + // log in cron run file + continue; + } + + $script = APPLICATION_ROOT . 'bin/cron.php'; + $stdout = get_log_file("cron/cron-run-{$run->name}.log"); + $command = PHP_BINARY . " $script -n {$run->name} >> {$stdout} 2>&1 &"; + $this->dbg("Execute Command Run: '{$command}'"); + exec($command, $output, $status); + if ($status != 0) { + $this->dbg("Command '{$command}' exited with status {$status}. Output: " . print_r($output, 1)); + } + } + } catch (Exception $e) { + error_log('Cron [Exception]: ' . $e->getMessage()); + error_log('Cron [Exception]: ' . $e->getTraceAsString()); + } + } + + protected function executeRun(Run $run) { + $this->dbg('----------'); + $this->dbg("cron-run call start for {$run->name}"); + + // get all session codes that have Branch, Pause, or Email lined up (not ended) + $sessions = $this->db->select('session')->from('survey_run_sessions') + ->where(array('run_id' => $run->id)) + ->order('RAND') + ->statement(); + + $done = array(); + $i = 0; + // Foreach session, execute all units + $run->getOwner(); + while ($row = $sessions->fetch(PDO::FETCH_ASSOC)) { + $session = $row['session']; + $runSession = new RunSession($session, $run); + $types = $runSession->execute(); // start looping thru their units. + $i++; + + if ($types === false) { + alert("This session '$session' caused problems", 'alert-danger'); + continue; + } + + foreach ($types as $type => $nr) { + if (!isset($done[$type])) { + $done[$type] = 0; + } + $done[$type] += (int)$nr; + } + } + + $executed_types = $this->parseExecutedUnitTypes($done); + + $msg = "$i sessions in the run " . $run->name . " were processed. {$executed_types}"; + $this->dbg($msg); + if (Site::getInstance()->alerts) { + $this->dbg("\n
"; + + if ($run_session && ($run_session->isCron() || $run_session->isTesting())) { + if ($error instanceof Exception) { + $message .= $error->getMessage(); + } else { + $message .= $error; + } + } + alert($message, 'alert-danger'); +} + +function print_hidden_opencpu_debug_message($ocpu_req, $public_message = '') { + $run_session = Site::getInstance()->getRunSession(); + if ($run_session && !$run_session->isCron() && $run_session->isTesting()) { + $date = date('Y-m-d H:i:s'); + + $message = $date . ': ' . $public_message . "
"; + + $message .= opencpu_debug($ocpu_req); + alert($message, 'alert-info hidden_debug_message hidden'); + } +} + +function redirect_to($location = '', $params = array()) { + if (formr_in_console()) { + return; + } + + $location = str_replace(PHP_EOL, '', (string)$location); + if (strpos($location, 'index') !== false) { + $location = ''; + } + + if (mb_substr($location, 0, 4) != 'http') { + $base = WEBROOT; + if (mb_substr($location, 0, 1) == '/') { + $location = $base . mb_substr($location, 1); + } else { + $location = $base . $location; + } + } + if ($params) { + $location .= '?' . http_build_query($params); + } + + Session::globalRefresh(); + Session::over(); + header("Location: $location"); + exit; +} + +function session_over($site, $user) { + static $closed; + if ($closed) { + return false; + } + /* + $_SESSION['site'] = $site; + $_SESSION['user'] = serialize($user); + */ + session_write_close(); + $closed = true; + return true; +} + +function formr_error($code = 500, $title = 'Bad Request', $text = 'Request could not be processed', $hint = null, $link = null, $link_text = null) { + $code = $code ? $code : 500; + $text = str_replace(APPLICATION_ROOT, '', $text); + if ($link === null) { + $link = site_url(); + } + + if ($link_text === null) { + $link_text = 'Go to Site'; + } + + if (php_sapi_name() == 'cli') { + echo date('r') . " Error {$code}: {$text} \n"; + exit; + } + + $view = new View('public/error', array( + 'code' => $code, + 'title' => $hint ? $hint : $title, + 'text' => $text, + 'link' => $link, + 'link_text' => $link_text, + )); + + $response = new Response(); + $response->setStatusCode($code, $title)->setContent($view->render())->send(); +} + +function formr_error_feature_unavailable() { + formr_error('503', 'Feature Unavailable', 'Sorry this feature is temporarily unavailable. Please try again later', '', 'javascript:history.back();', 'Go Back'); +} + +function h($text) { + if (!$text) { + return null; + } + + return htmlspecialchars($text); +} + +function debug($string) { + if (DEBUG) { + echo "
"; + print_r($string); + echo ""; + } +} + +function pr($string, $log = false) { + if (DEBUG > 0 && !$log) { + echo "
"; + var_dump($string); + echo ""; + } else { + formr_log(print_r($string, true)); + } +} + +function prb($string = null) { + static $output = ""; + if ($string === null) { + if (DEBUG > 0) { + echo "
"; + var_dump($string); + # print_r( debug_backtrace()); + echo ""; + } else { + formr_log($string); + } + } else { + $output .= "
" . $string; + } +} + +if (!function_exists('_')) { + + function _($text) { + return $text; + } + +} + +function used_opencpu($echo = false) { + static $used; + if ($echo): + pr("Requests: " . $used); + return $used; + endif; + if (isset($used)) { + $used++; + } else { + $used = 1; + } + return $used; +} + +function used_cache($echo = false) { + static $used; + if ($echo): + pr("Hashcache: " . $used); + return $used; + endif; + if (isset($used)) { + $used++; + } else { + $used = 1; + } + return $used; +} + +function used_nginx_cache($echo = false) { + static $used; + if ($echo): + pr("Nginx: " . $used); + return $used; + endif; + if (isset($used)) { + $used++; + } else { + $used = 1; + } + return $used; +} + +if (!function_exists('__')) { + + /** + taken from cakePHP + */ + function __($singular, $args = null) { + if (!$singular) { + return; + } + + $translated = _($singular); + if ($args === null) { + return $translated; + } elseif (!is_array($args)) { + $args = array_slice(func_get_args(), 1); + } + return vsprintf($translated, $args); + } + +} + +if (!function_exists('__n')) { + + /** + taken from cakePHP + */ + function __n($singular, $plural, $count, $args = null) { + if (!$singular) { + return; + } + + $translated = ngettext($singular, $plural, null, 6, $count); + if ($args === null) { + return $translated; + } elseif (!is_array($args)) { + $args = array_slice(func_get_args(), 3); + } + return vsprintf($translated, $args); + } + +} + +function endsWith($haystack, $needle) { + $length = strlen($needle); + if ($length == 0) { + return true; + } + + return (mb_substr($haystack, -$length) === $needle); +} + +/** + * Gets an environment variable from available sources, and provides emulation + * for unsupported or inconsistent environment variables (i.e. DOCUMENT_ROOT on + * IIS, or SCRIPT_NAME in CGI mode). Also exposes some additional custom + * environment information. + * + * @param string $key Environment variable name. + * @return string Environment variable setting. + * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#env + */ +function env($key) { + if ($key === 'HTTPS') { + if (isset($_SERVER['HTTPS'])) { + return (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off'); + } + return (mb_strpos(env('SCRIPT_URI'), 'https://') === 0); + } + + if ($key === 'SCRIPT_NAME') { + if (env('CGI_MODE') && isset($_ENV['SCRIPT_URL'])) { + $key = 'SCRIPT_URL'; + } + } + + $val = null; + if (isset($_SERVER[$key])) { + $val = $_SERVER[$key]; + } elseif (isset($_ENV[$key])) { + $val = $_ENV[$key]; + } elseif (getenv($key) !== false) { + $val = getenv($key); + } + + if ($key === 'REMOTE_ADDR' && $val === env('SERVER_ADDR')) { + $addr = env('HTTP_PC_REMOTE_ADDR'); + if ($addr !== null) { + $val = $addr; + } + } + + if ($val !== null) { + return $val; + } + + switch ($key) { + case 'SCRIPT_FILENAME': + if (defined('SERVER_IIS') && SERVER_IIS === true) { + return str_replace('\\\\', '\\', env('PATH_TRANSLATED')); + } + break; + case 'DOCUMENT_ROOT': + $name = env('SCRIPT_NAME'); + $filename = env('SCRIPT_FILENAME'); + $offset = 0; + if (!mb_strpos($name, '.php')) { + $offset = 4; + } + return mb_substr($filename, 0, -(strlen($name) + $offset)); + case 'PHP_SELF': + return str_replace(env('DOCUMENT_ROOT'), '', env('SCRIPT_FILENAME')); + case 'CGI_MODE': + return (PHP_SAPI === 'cgi'); + case 'HTTP_BASE': + $host = env('HTTP_HOST'); + $parts = explode('.', $host); + $count = count($parts); + + if ($count === 1) { + return '.' . $host; + } elseif ($count === 2) { + return '.' . $host; + } elseif ($count === 3) { + $gTLD = array( + 'aero', + 'asia', + 'biz', + 'cat', + 'com', + 'coop', + 'edu', + 'gov', + 'info', + 'int', + 'jobs', + 'mil', + 'mobi', + 'museum', + 'name', + 'net', + 'org', + 'pro', + 'tel', + 'travel', + 'xxx' + ); + if (in_array($parts[1], $gTLD)) { + return '.' . $host; + } + } + array_shift($parts); + return '.' . implode('.', $parts); + } + return null; +} + +function emptyNull(&$x) { + $x = is_formr_truthy($x) ? $x : null; +} + +function stringBool($x) { + if ($x === false) { + return 'false'; + } elseif ($x === true) { + return 'true'; + } elseif ($x === null) { + return 'null'; + } elseif ($x === 0) { + return '0'; + } elseif (is_array($x) AND empty($x)) { + return "NA"; + } + + return $x; +} + +function hardTrueFalse($x) { + if ($x === false) { + return 'FALSE'; + } elseif ($x === true) { + return 'TRUE'; +# elseif($x===null) return 'NULL'; + } elseif ($x === 0) { + return '0'; + } + + return $x; +} + +if (!function_exists('http_parse_headers')) { + + function http_parse_headers($raw_headers) { + $headers = array(); + $key = ''; // [+] + + foreach (explode("\n", $raw_headers) as $i => $h) { + $h = explode(':', $h, 2); + + if (isset($h[1])) { + if (!isset($headers[$h[0]])) { + $headers[$h[0]] = trim($h[1]); + } elseif (is_array($headers[$h[0]])) { + // $tmp = array_merge($headers[$h[0]], array(trim($h[1]))); // [-] + // $headers[$h[0]] = $tmp; // [-] + $headers[$h[0]] = array_merge($headers[$h[0]], array(trim($h[1]))); // [+] + } else { + // $tmp = array_merge(array($headers[$h[0]]), array(trim($h[1]))); // [-] + // $headers[$h[0]] = $tmp; // [-] + $headers[$h[0]] = array_merge(array($headers[$h[0]]), array(trim($h[1]))); // [+] + } + + $key = $h[0]; // [+] + } else { // [+] // [+] + if (mb_substr($h[0], 0, 1) == "\t") { // [+] + $headers[$key] .= "\r\n\t" . trim($h[0]); // [+] + } elseif (!$key) { // [+] + $headers[0] = trim($h[0]); // [+] + } + } // [+] + } + + return $headers; + } + +} + +/** + * Format a timestamp to display its age (5 days ago, in 3 days, etc.). + * + * @param int $timestamp + * @return string + */ +function timetostr($timestamp) { + if ($timestamp === false) { + return ""; + } + $age = time() - $timestamp; + + $future = ($age <= 0); + $age = abs($age); + + $age = (int) ($age / 60); // minutes ago + if ($age == 0) { + return $future ? "a moment" : "just now"; + } + + $scales = [ + ["minute", "minutes", 60], + ["hour", "hours", 24], + ["day", "days", 7], + ["week", "weeks", 4.348214286], // average with leap year every 4 years + ["month", "months", 12], + ["year", "years", 10], + ["decade", "decades", 10], + ["century", "centuries", 1000], + ["millenium", "millenia", PHP_INT_MAX] + ]; + + foreach ($scales as $scale) { + list($singular, $plural, $factor) = $scale; + if ($age == 0) { + return $future ? "less than 1 $singular" : "less than 1 $singular ago"; + } + if ($age == 1) { + return $future ? "1 $singular" : "1 $singular ago"; + } + if ($age < $factor) { + return $future ? "$age $plural" : "$age $plural ago"; + } + + $age = (int) ($age / $factor); + } +} + +// from http://de1.php.net/manual/en/function.filesize.php +function human_filesize($bytes, $decimals = 2) { + $sz = 'BKMGTP'; + $factor = floor((strlen($bytes) - 1) / 3); + return sprintf("%.{$decimals}f", $bytes / pow(1024, $factor)) . @$sz[$factor]; +} + +function cr2nl($string) { + return str_replace("\r\n", "\n", (string)$string); +} + +function time_point($line, $file) { + static $times, $points; + if (empty($times)) { + $times = array($_SERVER["REQUEST_TIME_FLOAT"]); + $points = array("REQUEST TIME " . round($_SERVER["REQUEST_TIME_FLOAT"] / 60, 6)); + } + $took = $times[count($times) - 1]; + $times[] = microtime(true); + $took = round(($times[count($times) - 1] - $took) / 60, 6); + $points[] = "took $took minutes to get to line " . $line . " in file: " . $file; + return $points; +} + +function echo_time_points($points) { +// echo ""; +} + +function crypto_token($length, $url = true) { + $bytes = openssl_random_pseudo_bytes($length, $crypto_strong); + $base64 = base64_url_encode($bytes); + if (!$crypto_strong) { + formr_error(500, 'Internal Server Error', 'Generated cryptographic tokens are not strong.', 'Cryptographic Error'); + } + return $base64; +} + +function base64_url_encode($data) { + return strtr(base64_encode($data), '+/=', '-_~'); +} + +function base64_url_decode($data) { + return base64_decode(strtr($data, '-_~', '+/=')); +} + +/** + * Create URL Title + * + * Takes a "title" string as input and creates a + * human-friendly URL string with a "separator" string + * as the word separator. + * + * @param string the string + * @param string the separator + * @param strin $lowercase Should string be returned in lowecase letters + * @return string + */ +function url_title($str, $separator = '-', $lowercase = false) { + if ($separator == 'dash') { + $separator = '-'; + } else if ($separator == 'underscore') { + $separator = '_'; + } + $q_separator = preg_quote($separator); + $trans = array( + '&.+?;' => '', + '[^a-z0-9 _-]' => '', + '\s+' => $separator, + '(' . $q_separator . ')+' => $separator + ); + $str = strip_tags($str); + foreach ($trans as $key => $val) { + $str = preg_replace("#" . $key . "#i", $val, $str); + } + + if ($lowercase === true) { + $str = strtolower($str); + } + + return trim($str, $separator); +} + +function empty_column($col, $arr) { + $empty = true; + $last = null; + foreach ($arr AS $row): + if (!(empty($row->$col)) || // not empty column? (also treats 0 and empty strings as empty) + $last != $row->$col || // any variation in this column? + !(!is_array($row->$col) && trim((string)$row->$col) == '')): + $empty = false; + break; + endif; + $last = $row->$col; + endforeach; + return $empty; +} + +/** + * Return an array of contents in the run export directory + * + * @param string $dir Absolute path to readable directory + * @return mixed Returns an array if all is well or FALSE otherwise + */ +function get_run_dir_contents($dir) { + if (!$dir || !is_dir($dir) || !is_readable($dir)) { + return false; + } + + $files = glob($dir . '/*.json'); + if (!$files) { + return false; + } + + $contents = array(); + foreach ($files as $file) { + $file_contents = file_get_contents($file); + $json = json_decode($file_contents); + if ($json) { + $contents[basename($file)] = $json->name; + } + } + return $contents; +} + +/** + * Get the mime type of a file given filename using FileInfo + * @see http://php.net/manual/en/book.fileinfo.php + * + * @param string $filename + * @return mixed Returns the mime type as a string or FALSE otherwise + */ +function get_file_mime($filename) { + $constant = defined('FILEINFO_MIME_TYPE') ? FILEINFO_MIME_TYPE : FILEINFO_MIME; + $finfo = finfo_open($constant); + $info = finfo_file($finfo, $filename); + finfo_close($finfo); + $mime = explode(';', $info); + if (!$mime) { + return false; + } + + $mime_type = $mime[0]; + return $mime_type; +} + +/** + * Send a file for download to client + * + * @param string $file Absolute path to file + * @param boolean $unlink + * @todo implement caching stuff + */ +function download_file($file, $unlink = false) { + $type = get_file_mime($file); + $filename = basename($file); + $filesize = filesize($file); + header('Content-Description: File Transfer'); + header('Content-Type: ' . $type); + header('Content-Disposition: attachment; filename = "' . $filename . '"'); + header('Content-Transfer-Encoding: binary'); + header('Expires: 0'); + header('Cache-Control: must-revalidate, post-check=0, pre-check=0'); + if ($filesize) { + header('Content-Length: ' . $filesize); + } + readfile($file); + if ($unlink) { + unlink($file); + } + exit(0); +} + +/** + * @deprecated + */ +function get_duplicate_update_string($columns) { + foreach ($columns as $i => $column) { + $column = trim($column, '`'); + $columns[$i] = "`$column` = VALUES(`$column`)"; + } + return $columns; +} + +/** + * Returns a valid MySQL datetime string + * + * @param int $time [optional] Valid unix timestamp + * @return string + */ +function mysql_datetime($time = null) { + if ($time === null) { + $time = time(); + } + if (is_string($time)) { + $time = strtotime($time); + } + return date('Y-m-d H:i:s', $time); +} + +/** + * Returns a string equivalent to MySQL's NOW() function + * + * @return string + */ +function mysql_now() { + return mysql_datetime(); +} + +/** + * Returns formatted strings equivalent to expressions like NOW() + INTERVAL 2 DAY + * + * @param string A string defining an interval accepted by PHP's strtotime() function + * @return string + */ +function mysql_interval($interval) { + if (($time = strtotime($interval)) === false) { + throw new Exception("Invalid time interval given to strtotime '$interval'"); + } + return mysql_datetime($time); +} + +function site_url($uri = '', $params = array()) { + $url = WEBROOT; + if ($uri) { + $url .= $uri . '/'; + } + if ($params) { + $url .= '?' . http_build_query($params); + } + return trim($url, '\/\\'); +} + +function admin_url($uri = '', $params = array()) { + if ($uri) { + $uri = '/' . $uri; + } + return site_url('admin' . $uri, $params); +} + +function run_url($name = '', $action = '', $params = array()) { + if ($name === Run::TEST_RUN) { + return site_url('run/' . $name . '/' . $action); + } + + $protocol = Config::get('define_root.protocol'); + $domain = trim(Config::get('define_root.doc_root', ''), "\/\\"); + $subdomain = null; + if (Config::get('use_study_subdomains')) { + $domain = Config::get('define_root.study_domain', $domain); # use different domain for studies if set + $subdomain = strtolower($name) . '.'; + } else { + $domain .= '/' . $name; + } + $url = $protocol . $subdomain . $domain; + if ($action) { + $action = trim($action, "\/\\"); + $url .= '/' . $action . '/'; + } + if ($params) { + $url .= '?' . http_build_query($params); + } + return $url; +} + +function admin_study_url($name = '', $action = '', $params = array()) { + if ($action) { + $name = $name . '/' . $action; + } + return admin_url('survey/' . $name, $params); +} + +function admin_run_url($name = '', $action = '', $params = array()) { + if ($action) { + $name = $name . '/' . $action; + } + return admin_url('run/' . $name, $params); +} + +/** + * modified from https://stackoverflow.com/questions/118884/what-is-an-elegant-way-to-force-browsers-to-reload-cached-css-js-files?rq=1 + * Given a file, i.e. /css/base.css, replaces it with a string containing the + * file's mtime, i.e. /css/base.1221534296.css. + * + * @param $file The file to be loaded. Must not start with a slash. + */ +function asset_url($file) { + if (strpos($file, 'http') !== false || strpos($file, '//') === 0) { + return $file; + } + if (strpos($file, 'assets') === false) { + $file = 'assets/' . $file; + } + $mtime = @filemtime(APPLICATION_ROOT . "webroot/" . $file); + if (!$mtime) { + return site_url($file); + } + return site_url($file . "?v" . $mtime); +} + +function monkeybar_url($run_name, $action = '', $params = array()) { + return run_url($run_name, 'monkey-bar/' . $action, $params); +} + +function array_to_accordion($array) { + $rand = mt_rand(0, 10000); + $acc = '
';
+ $first = ' in';
+
+ foreach ($array as $title => $content):
+ if ($content == null) {
+ $content = stringBool($content);
+ }
+ $id = 'collapse' . str_replace(' ', '', $rand . $title);
+
+ $acc .= '
+
';
+ return $acc;
+}
+
+function array_to_orderedlist($array, $olclass = null, $liclass = null) {
+ $ol = '
+
+
';
+ $first = '';
+ endforeach;
+
+ $acc .= '
+
+
+ ' . $content . '
+
+ - ';
+ foreach ($array as $title => $label) {
+ if (is_formr_truthy($label)) {
+ $ol .= '
- ' . $label . ' '; + } + } + $ol .= '
+ '; + } elseif (isset($params['x'])) { + $debug['R Code'] = ' + Download R code file to debug.
+ '; + } + if ($session->hasError()) { + $debug['Response'] = pre_htmlescape($session->getError()); + } else { + if (($files = $session->getFiles("knit.html"))) { + $iframesrc = $files['knit.html']; + $debug['Response'] = ' + '; + } else if (isset($params['text']) || $rtype === 'text') { + $debug['Response'] = stringBool($session->getObject('text')); + } else { + $debug['Response'] = pre_htmlescape(json_encode($session->getJSONObject(), JSON_PRETTY_PRINT + JSON_UNESCAPED_UNICODE)); + } + } + + $urls = $session->getResponsePathsAsLinks(); + if (!$session->hasError() AND!empty($urls)) { + $locations = ''; + foreach ($urls AS $path => $link) { + $path = str_replace('/ocpu/tmp/' . $session->getKey(), '', $path); + $locations .= "$path
"; + } + $debug['Locations'] = $locations; + } + $debug['Session Info'] = pre_htmlescape($session->getInfo()); + $debug['Session Console'] = pre_htmlescape($session->getConsole()); + $debug['Session Stdout'] = pre_htmlescape($session->getStdout()); + $debug['Request'] = pre_htmlescape((string) $request); + + $reponse_headers = $session->getResponseHeaders(); + $debug['Response Headers'] = pre_htmlescape(print_r($reponse_headers, 1)); + + $reponse_info = $session->caller()->getRequestInfo(); + $debug['Request Headers'] = pre_htmlescape(print_r($reponse_info['request_header'], 1)); + } catch (Exception $e) { + $debug['Response'] = 'An error occured: ' . $e->getMessage(); + } + } + + return array_to_accordion($debug); +} + +function opencpu_log($msg) { + $log = ''; + if ($msg instanceof Exception) { + $log .= $msg->getMessage() . "\n" . $msg->getTraceAsString(); + } else { + $log .= $msg; + } + error_log($log . "\n", 3, get_log_file('opencpu.log')); +} + +function opencpu_formr_variables($q) { + $variables = []; + if (preg_match("/\btime_passed\b/", (string)$q)) { + $variables[] = 'formr_last_action_time'; + } + if (preg_match("/\bnext_day\b/", (string)$q)) { + $variables[] = 'formr_last_action_date'; + } + if (strstr((string)$q, '.formr$login_code') !== false) { + $variables[] = 'formr_login_code'; + } + if (preg_match("/\buser_id\b/", (string)$q)) { + $variables[] = 'user_id'; + } + if (strstr((string)$q, '.formr$login_link') !== false) { + $variables[] = 'formr_login_link'; + } + if (strstr((string)$q, '.formr$nr_of_participants') !== false) { + $variables[] = 'formr_nr_of_participants'; + } + if (strstr((string)$q, '.formr$session_last_active') !== false) { + $variables[] = 'formr_session_last_active'; + } + + return $variables; +} + +function pre_htmlescape($str) { + $str = (string) $str; + return '
' . htmlspecialchars($str) . ''; +} + +function array_val($array, $key, $default = "") { + if (!is_array($array)) { + return false; + } + if (array_key_exists($key, $array)) { + return $array[$key]; + } + return $default; +} + +function shutdown_formr_org() { + $user = Site::getCurrentUser(); + if (is_object($user) && $user->cron) { + return; + } + + $error = error_get_last(); + if ($error !== null && $error['type'] === E_ERROR && !DEBUG) { + $errno = $error["type"]; + $errfile = $error["file"]; + $errline = $error["line"]; + $errstr = $error["message"]; + $code = strtoupper(AnimalName::haikunate()); + + $msg = "A fatal error occured and your request could not be completed. Contact site admins with these details \n"; + $msg .= "Error [$errno] in $errfile line $errline \n $code"; + + formr_log("$msg \n $errstr", $code); + formr_error(500, 'Internal Server Error', nl2br($msg), 'Fatal Error'); + } +} + +function remove_tag_wrapper($text, $tag = 'p') { + $text = trim((string)$text); + if (preg_match("@^<{$tag}>(.+)$@", $text, $matches)) { + $text = isset($matches[1]) ? $matches[1] : $text; + } + return $text; +} + +function delete_tmp_file($file) { + // unlink tmp file especially for the case of google sheets + if (!empty($file['tmp_name']) && file_exists($file['tmp_name'])) { + @unlink($file['tmp_name']); + } +} + +/** + * Hackathon to dwnload an excel sheet from google + * + * @param string $survey_name + * @param string $google_link The URL of the Google Sheet + * @return array|boolean Returns an array similar to that of an 'uploaded-php-file' or FALSE otherwise; + */ +function google_download_survey_sheet($survey_name, $google_link) { + $google_id = google_get_sheet_id($google_link); + if (!$google_id) { + return false; + } + + $destination_file = Config::get('survey_upload_dir') . '/googledownload-' . $google_id . '.xlsx'; + $google_download_link = "http://docs.google.com/spreadsheets/d/{$google_id}/export?format=xlsx&{$google_id}"; + $info = array(); + + try { + if (!is_writable(dirname($destination_file))) { + throw new Exception("The survey backup directory is not writable"); + } + $options = array( + CURLOPT_SSL_VERIFYHOST => 0, + CURLOPT_SSL_VERIFYPEER => 0, + ); + + CURL::DownloadUrl($google_download_link, $destination_file, null, CURL::HTTP_METHOD_GET, $options, $info); + if (empty($info['http_code']) || $info['http_code'] < 200 || $info['http_code'] > 302 || strstr($info['content_type'], "text/html") !== false) { + $link = google_get_sheet_link($google_id); + throw new Exception("The google sheet at {$link} could not be downloaded. Please make sure everyone with the link can access the sheet!"); + } + + $ret = array( + 'name' => $survey_name . '.xlsx', + 'tmp_name' => $destination_file, + 'size' => filesize($destination_file), + 'google_id' => $google_id, + 'google_file_id' => $google_id, + 'google_link' => google_get_sheet_link($google_id), + 'google_download_link' => $google_download_link, + ); + } catch (Exception $e) { + formr_log_exception($e, 'CURL_DOWNLOAD', $google_link); + alert($e->getMessage(), 'alert-danger'); + $ret = false; + } + return $ret; +} + +/** + * preg-match the Google sheet ID from the google sheet link + * + * @param string $link + * @return string|null + */ +function google_get_sheet_id($link) { + $matches = array(); + preg_match('/spreadsheets\/d\/(.*)\/edit/', $link, $matches); + if (!empty($matches[1])) { + return $matches[1]; + } + return null; +} + +/** + * Returns the google sheet link given ID + * + * @param string $id + * @return string + */ +function google_get_sheet_link($id) { + return "https://docs.google.com/spreadsheets/d/{$id}/edit"; +} + +function strt_replace($str, $params) { + foreach ($params as $key => $value) { + $str = str_replace('%{' . $key . '}', $value, $str); + $str = str_replace('{' . $key . '}', $value, $str); + } + return $str; +} + +function fill_array($array, $value = '') { + foreach ($array as $key => $v) { + $array[$key] = $value; + } + return $array; +} + +function files_are_equal($a, $b) { + if (!file_exists($a) || !file_exists($b)) + return false; + + // Check if filesize is different + if (filesize($a) !== filesize($b)) + return false; + + if (sha1_file($a) !== sha1_file($b)) + return false; + + return true; +} + +function create_zip_archive($files, $destination, $overwrite = false) { + $zip = new ZipArchive(); + + if ($zip->open($destination, $overwrite ? ZIPARCHIVE::OVERWRITE : ZIPARCHIVE::CREATE) !== true) { + return false; + } + + //add the files + foreach ($files as $file) { + if (is_file($file)) { + $zip->addFile($file, basename($file)); + } + } + $zip->close(); + + //check to make sure the file exists + return file_exists($destination); +} + +function create_ini_file($assoc, $filepath) { + file_put_contents($filepath, ''); + foreach ($assoc as $section => $fields) { + file_put_contents($filepath, "[{$section}]\n", FILE_APPEND); + foreach ($fields as $key => $value) { + file_put_contents($filepath, "{$key} = {$value}\n", FILE_APPEND); + } + file_put_contents($filepath, "\n", FILE_APPEND); + } + return file_exists($filepath); +} + +function deletefiles($files) { + foreach ($files as $file) { + if (is_file($file)) { + @unlink($file); + } + } +} + +function get_default_assets($config = 'site') { + if (DEBUG) { + return Config::get("default_assets.dev.{$config}"); + } else { + return Config::get("default_assets.prod.{$config}"); + } +} + +function get_assets() { + return get_default_assets('assets'); +} + +function print_stylesheets($files, $id = null) { + foreach ($files as $i => $file) { + $id = 'css-' . $i . $id; + echo '' . "\n"; + } +} + +function print_scripts($files, $id = null) { + foreach ($files as $i => $file) { + $id = 'js-' . $i . $id; + echo '' . "\n"; + } +} + +function fwrite_json($handle, $data) { + if ($handle) { + fseek($handle, 0, SEEK_END); + if (ftell($handle) > 0) { + fseek($handle, -1, SEEK_END); + fwrite($handle, ',', 1); + fwrite($handle, "\n" . json_encode($data) . "]"); + } else { + fwrite($handle, json_encode(array($data))); + } + } +} + +function do_run_shortcodes($text, $run_name, $sess_code) { + $link_tpl = '%{text}'; + if ($run_name) { + $login_url = run_url($run_name, null, array('code' => $sess_code)); + $logout_url = run_url($run_name, 'logout', array('code' => $sess_code)); + $settings_url = run_url($run_name, 'settings', array('code' => $sess_code)); + } else { + $login_url = $settings_url = site_url(); + $logout_url = site_url('logout'); + //alert("Generated a login link, but no run was specified", 'alert-danger'); + } + + + $settings_link = Template::replace($link_tpl, array('url' => $settings_url, 'text' => 'Settings Link')); + $login_link = Template::replace($link_tpl, array('url' => $login_url, 'text' => 'Login Link')); + $logout_link = Template::replace($link_tpl, array('url' => $logout_url, 'text' => 'Logout Link')); + + $text = str_replace("{{login_link}}", $login_link, (string)$text); + $text = str_replace("{{login_url}}", $login_url, $text); + $text = str_replace("{{login_code}}", urlencode($sess_code), $text); + $text = str_replace("{{settings_link}}", $settings_link, $text); + $text = str_replace("{{settings_url}}", $settings_url, $text); + $text = str_replace("{{logout_link}}", $logout_link, $text); + $text = str_replace("{{logout_url}}", $logout_url, $text); + $text = str_replace(urlencode("{{login_url}}"), $login_url, $text); + $text = str_replace(urlencode("{{login_code}}"), urlencode($sess_code), $text); + $text = str_replace(urlencode("{{settings_url}}"), $settings_url, $text); + $text = str_replace(urlencode("{{logout_url}}"), $logout_url, $text); + + return $text; +} + +function factortosecs($value, $unit) { + $factors = array( + 'seconds' => 1, + 'minutes' => 60, + 'hours' => 3600, + 'days' => 86400, + 'months' => 30 * 86400, + 'years' => 365 * 86400, + ); + + if (isset($factors[$unit])) { + return $value * $factors[$unit]; + } else { + return null; + } +} + +function secstofactor($seconds) { + if (!$seconds) { + return null; + } + + $factors = array( + 'years' => 365 * 86400, + 'months' => 30 * 86400, + 'days' => 86400, + 'hours' => 3600, + 'minutes' => 60, + 'seconds' => 1, + ); + + foreach ($factors as $unit => $factor) { + if ($seconds % $factor === 0) { + return array($seconds / $factor, $unit); + } + } + return array($seconds, 'seconds'); +} + +function knitting_needed($source) { + if (!$source) { + return false; + } + + if (mb_strpos($source, '`r ') !== false || mb_strpos($source, '```{r') !== false) { + return true; + } + + return false; +} + +function get_db_non_user_tables() { + return [ + 'survey_users' => array("created", "modified", "user_code", "email", "email_verified", "mobile_number", "mobile_verified"), + 'survey_run_sessions' => array("session", "created", "last_access", "position", "current_unit_id", "deactivated", "no_email"), + 'survey_unit_sessions' => array("created", "ended", 'expired', "unit_id", "position", "type"), + 'externals' => array("created", "ended", 'expired', "position"), + 'survey_items_display' => array("created", "answered_time", "answered", "displaycount", "item_id"), + 'survey_email_log' => array("email_id", "created", "recipient"), + 'shuffle' => array("unit_id", "created", "group"), + ]; +} + +function get_db_non_session_tables() { + return ['survey_users', 'survey_run_sessions', 'survey_unit_sessions']; +} + +function formr_check_maintenance() { + $ip = env('REMOTE_ADDR'); + + if (Config::get('in_maintenance') && !in_array($ip, Config::get('maintenance_ips', []))) { + formr_error(503, 'Service Unavailable', 'This website is currently undergoing maintenance. Please try again later.', 'Maintenance Mode', false); + } +} + +function formr_in_console() { + return php_sapi_name() === 'cli'; +} + +function formr_search_highlight($search, $subject) { + return str_replace($search, ''.$search.'', $subject); +} diff --git a/application/Helper/ApiHelper.php b/application/Helper/ApiHelper.php index 2e29f79e5..334550a8a 100644 --- a/application/Helper/ApiHelper.php +++ b/application/Helper/ApiHelper.php @@ -2,333 +2,314 @@ class ApiHelper { - /** - * @var DB - */ - protected $fdb; - - /** - * @var Request - */ - protected $request; - - /** - * A conainer to hold processed request's outcome - * - * @var array - */ - protected $data = array( - 'statusCode' => Response::STATUS_OK, - 'statusText' => 'OK', - 'response' => array(), - ); - - /** - * Formr user object current accessing data - * @var User - */ - protected $user = null; - - /** - * Error information - * - * @var array - */ - protected $error = array(); - - public function __construct(Request $request, DB $db) { - $this->fdb = $db; - $this->request = $request; - $this->user = OAuthHelper::getInstance()->getUserByAccessToken($this->request->getParam('access_token')); - } - - public function results() { - /** - * $request in this method is expected to be an object of the following format - * $request = '{ - * run: { - * name: 'some_run_name', - * api_secret: 'run_api_secret_as_show_in_run_settings' - * surveys: [{ - * name: 'survey_name', - * items: 'name, email, pov_1' - * }], - * sessions: ['xxxx', 'xxxx'] - * } - * }' - */ - - // Get run object from request - $request_run = $this->request->arr('run'); - $request_surveys = $this->request->arr('surveys'); - $request = array('run' => array( - 'name' => array_val($request_run, 'name', null), - 'session' => array_val($request_run, 'session', null), - 'sessions' => array_filter(explode(',', array_val($request_run, 'sessions', false))), - 'surveys' => array() - )); - foreach ($request_surveys as $survey_name => $survey_fields) { - $request['run']['surveys'][] = (object)array( - 'name' => $survey_name, - 'items' => $survey_fields, - ); - } - - $request = json_decode(json_encode($request)); - if (!($run = $this->getRunFromRequest($request))) { - return $this; - } - $requested_run = $request->run; - - // Determine which surveys in the run for which to collect data - if (!empty($requested_run->survey)) { - $surveys = array($requested_run->survey); - } elseif (!empty($requested_run->surveys)) { - $surveys = $requested_run->surveys; - } else { - $surveys = array(); - $run_surveys = $run->getAllSurveys(); - foreach ($run_surveys as $survey) { - /** @var Survey $svy */ - $svy = Survey::loadById($survey['id']); - $items = $svy->getItems('id, type, name'); - $items_names = array(); - foreach ($items as $item) { - $items_names[] = $item['name']; - } - $surveys[] = (object) array( - 'name' => $svy->name, - 'items' => implode(',', $items_names), - 'object' => $svy, - ); + /** + * @var DB + */ + protected $db; + + /** + * @var Request + */ + protected $request; + + /** + * A conainer to hold processed request's outcome + * + * @var array + */ + protected $data = array( + 'statusCode' => Response::STATUS_OK, + 'statusText' => 'OK', + 'response' => array(), + ); + + /** + * Formr user object current accessing data + * @var User + */ + protected $user = null; + + /** + * Error information + * + * @var array + */ + protected $error = array(); + + public function __construct(Request $request, DB $db) { + $this->db = $db; + $this->request = $request; + $this->user = OAuthHelper::getInstance()->getUserByAccessToken($this->request->getParam('access_token')); + } + + public function results() { + ini_set('memory_limit', Config::get('memory_limit.run_get_data')); + + // Get run object from request + $request_run = $this->request->arr('run'); + $request_surveys = $this->request->arr('surveys'); + $request = array('run' => array( + 'name' => array_val($request_run, 'name', null), + 'session' => array_val($request_run, 'session', null), + 'sessions' => array_filter(explode(',', array_val($request_run, 'sessions', false))), + 'surveys' => array() + )); + + foreach ($request_surveys as $survey_name => $survey_fields) { + $request['run']['surveys'][] = (object) array( + 'name' => $survey_name, + 'items' => $survey_fields, + ); + } + + $request = json_decode(json_encode($request)); + if (!($run = $this->getRunFromRequest($request))) { + return $this; + } + + // If sessions are still not available then run is empty + if (!$this->db->count('survey_run_sessions', array('run_id' => $run->id), 'id')) { + $this->setData(Response::STATUS_NOT_FOUND, 'Empty Run', null, 'No sessions were found in this run.'); + return $this; + } + + $requested_run = $request->run; + + // Determine which surveys in the run for which to collect data + if (!empty($requested_run->survey)) { + $surveys = array($requested_run->survey); + } elseif (!empty($requested_run->surveys)) { + $surveys = $requested_run->surveys; + } else { + $surveys = array(); + $run_surveys = $run->getAllSurveys(); + foreach ($run_surveys as $survey) { + $surveys[] = (object) array( + 'name' => $survey['name'], + 'items' => null, + ); + } + } + + // Determine which run sessions in the run will be returned. + // (For now let's prevent returning data of all sessions so this should be required) + if (!empty($requested_run->session)) { + $requested_run->sessions = array($requested_run->session); + } + + $results = array(); + foreach ($surveys as $s) { + $results[$s->name] = $this->getSurveyResults($run, $s->name, $s->items, $requested_run->sessions); + } + + $this->setData(Response::STATUS_OK, 'OK', $results); + return $this; + } + + public function createSession() { + if (!($request = $this->parseJsonRequest()) || !($run = $this->getRunFromRequest($request))) { + return $this; + } + + $i = 0; + $run_session = new RunSession(null, $run); + $code = null; + if (!empty($request->run->code)) { + $code = $request->run->code; + } + + if (!is_array($code)) { + $code = array($code); + } + + $sessions = array(); + foreach ($code as $session) { + if (($created = $run_session->create($session))) { + $sessions[] = $run_session->session; + $i++; + } + } + + if ($i) { + $this->setData(Response::STATUS_OK, 'OK', array('created_sessions' => $i, 'sessions' => $sessions)); + } else { + $this->setData(Response::STATUS_INTERNAL_SERVER_ERROR, 'Error Request', null, 'Error occured when creating session'); + } + + return $this; + } + + public function endLastExternal() { + if (!($request = $this->parseJsonRequest())) { + return $this; + } + + $run = new Run($request->run->name); + if (!$run->valid) { + $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Invalid Run'); + return $this; + } + + if (!empty($request->run->session)) { + $session_code = $request->run->session; + $run_session = new RunSession($session_code, null); + + if ($run_session->id) { + $run_session->endLastExternal(); + $this->setData(Response::STATUS_OK, 'OK', array('success' => 'external unit ended')); + } else { + $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Invalid user session'); + } + } else { + $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Session code not found'); + } + + return $this; + } + + public function getData() { + return $this->data; + } + + /** + * Get Run object from an API request + * $request object must have a root element called 'run' which must have child elements called 'name' and 'api_secret' + * Example: + * $request = '{ + * run: { + * name: 'some_run_name', + * api_secret: 'run_api_secret_as_show_in_run_settings' + * } + * }' + * + * @param object $request A JSON object of the sent request + * @return boolean|Run Returns a run object if a valid run is found or FALSE otherwise + */ + protected function getRunFromRequest($request) { + if (empty($request->run->name)) { + $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Required "run : { name: }" parameter not found.'); + return false; + } + + $run = new Run($request->run->name); + if (!$run->valid || !$this->user) { + $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Invalid Run or run/user not found'); + return false; + } elseif (!$this->user->created($run)) { + $this->setData(Response::STATUS_UNAUTHORIZED, 'Unauthorized Access', null, 'Unauthorized access to run'); + return false; + } + + return $run; + } + + private function setData($statusCode = null, $statusText = null, $response = null, $error = null) { + if ($error !== null) { + $this->setError($statusCode, $statusText, $error); + return $this->setData($statusCode, $statusText, $this->error); + } + + if ($statusCode !== null) { + $this->data['statusCode'] = $statusCode; + } + if ($statusText !== null) { + $this->data['statusText'] = $statusText; + } + if ($response !== null) { + $this->data['response'] = $response; + } + } + + private function setError($code = null, $error = null, $desc = null) { + if ($code !== null) { + $this->error['error_code'] = $code; + } + if ($error !== null) { + $this->error['error'] = $error; + } + if ($desc !== null) { + $this->error['error_description'] = $desc; + } + } + + private function parseJsonRequest() { + $request = $this->request->str('request', null) ? $this->request->str('request') : file_get_contents('php://input'); + if (!$request) { + $this->setData(Response::STATUS_BAD_REQUEST, 'Invalid Request', null, "Request payload not found"); + return false; + } + $object = json_decode($request); + if (!$object) { + $this->setData(Response::STATUS_BAD_REQUEST, 'Invalid Request', null, "Unable to parse JSON request"); + return false; + } + return $object; + } + + private function getSurveyResults(Run $run, $survey_name, $survey_items = null, $sessions = null) { + $results = array(); + $query = $query = $this->buildSurveyResultsQuery($run, $survey_name, $survey_items, $sessions); + $stmt = $this->db->query($query, true); + + while (($row = $stmt->fetch(PDO::FETCH_ASSOC))) { + $session_id = $row['session_id']; + if (!isset($results[$session_id])) { + $results[$session_id] = array( + 'session' => $row['run_session'], + 'created' => $row['created'], + 'current_position' => $row['current_position' + ]); + } + if ($row['created'] && !$results[$session_id]['created']) { + $results[$session_id]['created'] = $row['created']; } - } - - // Determine which run sessions in the run will be returned. - // (For now let's prevent returning data of all sessions so this should be required) - if (!empty($requested_run->session)) { - $requested_run->sessions = array($requested_run->session); - } - // If no specific sessions are requested then return all sessions - if (empty($requested_run->sessions)) { - $sessions = $this->fdb->find('survey_run_sessions', array('run_id' => $run->id), array('cols' => 'session')); - foreach ($sessions as $sess) { - $requested_run->sessions[] = $sess['session']; - } - } - - // If sessions are still not available then run is empty - if (empty($requested_run->sessions)) { - $this->setData(Response::STATUS_NOT_FOUND, 'Empty Run', null, 'No sessions were found in this run.'); - return $this; - } - - - // Get result for each survey for each session - $results = array(); - foreach ($surveys as $s) { - if (empty($s->name)) { - continue; - } - if (empty($s->object)) { - $s->object = Survey::loadByUserAndName($this->user, $s->name); - } - - /** @var Survey $svy */ - $svy = $s->object; - if (empty($svy->valid)) { - $results[$s->name] = null; - continue; - } - - if (empty($s->items)) { - $items = array(); - } elseif (is_array($s->items)) { - $items = array_map('trim', $s->items); - } elseif (is_string($s->items)) { - $items = array_map('trim', explode(',', $s->items)); - } else { - throw new Exception("Invalid type for survey items. Type: " . gettype($s->itmes)); - } - - //Get data for all requested sessions in this survey - $results[$s->name] = array(); - foreach ($requested_run->sessions as $session) { - $results[$s->name] = array_merge($results[$s->name], $this->getSurveyResults($svy, $session, $items)); - } - } - - $this->setData(Response::STATUS_OK, 'OK', $results); - return $this; - } - - public function createSession() { - if (!($request = $this->parseJsonRequest()) || !($run = $this->getRunFromRequest($request))) { - return $this; - } - - $i = 0; - $run_session = new RunSession($this->fdb, $run->id, null, null, null); - $code = null; - if (!empty($request->run->code)) { - $code = $request->run->code; - } - - if (!is_array($code)) { - $code = array($code); - } - - $sessions = array(); - foreach ($code as $session) { - if (($created = $run_session->create($session))) { - $sessions[] = $run_session->session; - $i++; - } - } - - if ($i) { - $this->setData(Response::STATUS_OK, 'OK', array('created_sessions' => $i, 'sessions' => $sessions)); - } else { - $this->setData(Response::STATUS_INTERNAL_SERVER_ERROR, 'Error Request', null, 'Error occured when creating session'); - } - - return $this; - } - - public function endLastExternal() { - if (!($request = $this->parseJsonRequest())) { - return $this; - } - - $run = new Run($this->fdb, $request->run->name); - if (!$run->valid) { - $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Invalid Run'); - return $this; - } - - if (!empty($request->run->session)) { - $session_code = $request->run->session; - $run_session = new RunSession($this->fdb, $run->id, null, $session_code, null); - - if ($run_session->session !== NULL) { - $run_session->endLastExternal(); - $this->setData(Response::STATUS_OK, 'OK', array('success' => 'external unit ended')); - } else { - $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Invalid user session'); - } - } else { - $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Session code not found'); - } - - return $this; - } - - public function getData() { - return $this->data; - } - - /** - * Get Run object from an API request - * $request object must have a root element called 'run' which must have child elements called 'name' and 'api_secret' - * Example: - * $request = '{ - * run: { - * name: 'some_run_name', - * api_secret: 'run_api_secret_as_show_in_run_settings' - * } - * }' - * - * @param object $request A JSON object of the sent request - * @return boolean|Run Returns a run object if a valid run is found or FALSE otherwise - */ - protected function getRunFromRequest($request) { - if (empty($request->run->name)) { - $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Required "run : { name: }" parameter not found.'); - return false; - } - - $run = new Run($this->fdb, $request->run->name); - if(!$run->valid || !$this->user) { - $this->setData(Response::STATUS_NOT_FOUND, 'Not Found', null, 'Invalid Run or run/user not found'); - return false; - } elseif (!$this->user->created($run)) { - $this->setData(Response::STATUS_UNAUTHORIZED, 'Unauthorized Access', null, 'Unauthorized access to run'); - return false; - } - - return $run; - } - - private function setData($statusCode = null, $statusText = null, $response = null, $error = null) { - if ($error !== null) { - $this->setError($statusCode, $statusText, $error); - return $this->setData($statusCode, $statusText, $this->error); - } - - if ($statusCode !== null) { - $this->data['statusCode'] = $statusCode; - } - if ($statusText !== null) { - $this->data['statusText'] = $statusText; - } - if ($response !== null) { - $this->data['response'] = $response; - } - } - - private function setError($code = null, $error = null, $desc = null) { - if ($code !== null) { - $this->error['error_code'] = $code; - } - if ($error !== null) { - $this->error['error'] = $error; - } - if ($desc !== null) { - $this->error['error_description'] = $desc; - } - } - - private function parseJsonRequest() { - $request = $this->request->str('request', null) ? $this->request->str('request') : file_get_contents('php://input'); - if (!$request) { - $this->setData(Response::STATUS_BAD_REQUEST, 'Invalid Request', null, "Request payload not found"); - return false; - } - $object = json_decode($request); - if (!$object) { - $this->setData(Response::STATUS_BAD_REQUEST, 'Invalid Request', null, "Unable to parse JSON request"); - return false; - } - return $object; - } - - private function getSurveyResults(Survey $survey, $session = null, $requested_items = array()) { - $data = $survey->getItemDisplayResults($requested_items, array('session' => $session)); - // Get requested item names to match by id - $select = $this->fdb->select('id, name') - ->from('survey_items') - ->where(array('study_id' => $survey->id)); - if ($requested_items) { - $select->whereIn('name', $requested_items); - } - $stmt = $select->statement(); - $items = array(); - while (($row = $stmt->fetch(PDO::FETCH_ASSOC))) { - $items[$row['id']] = $row['name']; - } - - $results = array(); - foreach ($data as $row) { - if (!isset($items[$row['item_id']])) { - continue; - } - $session_id = $row['unit_session_id']; - if (!isset($results[$session_id])) { - $results[$session_id] = array('session' => $session); - } - $results[$session_id][$items[$row['item_id']]] = $row['answer']; - } - return array_values($results); - } + $results[$session_id][$row['item_name']] = $row['answer']; + } + + return array_values($results); + } + + private function buildSurveyResultsQuery(Run $run, $survey_name, $survey_items = null, $sessions = null) { + $params = array( + 'run_id' => $run->id, + 'user_id' => $this->user->id, + 'survey_name' => $this->db->quote($survey_name), + 'WHERE_survey_items' => null, + 'WHERE_run_sessions' => null, + ); + + $q = ' + SELECT itms_display.item_id, itms_display.session_id, itms_display.answer, itms_display.created, + survey_items.name AS item_name, survey_run_sessions.session AS run_session, survey_run_sessions.position AS current_position + FROM survey_items_display AS itms_display + LEFT JOIN survey_unit_sessions ON survey_unit_sessions.id = itms_display.session_id + LEFT JOIN survey_run_sessions ON survey_run_sessions.id = survey_unit_sessions.run_session_id + LEFT JOIN survey_items ON survey_items.id = itms_display.item_id + LEFT JOIN survey_studies ON survey_studies.id = survey_items.study_id + WHERE survey_studies.name = %{survey_name} + AND survey_studies.user_id = %{user_id} + AND survey_run_sessions.run_id = %{run_id} + %{WHERE_survey_items} + %{WHERE_run_sessions} + '; + + if ($survey_items && is_string($survey_items)) { + $itms = array(); + foreach (explode(',', $survey_items) as $itm) { + $itms[] = $this->db->quote(trim($itm)); + } + $params['WHERE_survey_items'] = ' AND survey_items.name IN (' . implode(',', $itms) . ') '; + } + + if ($sessions && is_array($sessions)) { + $or_like = array(); + foreach ($sessions as $session) { + $or_like[] = " survey_run_sessions.session LIKE '{$session}%' "; + } + $params['WHERE_run_sessions'] = ' AND (' . implode('OR', $or_like) . ') '; + } + + return Template::replace($q, $params); + } } diff --git a/application/Helper/GearmanWorkerHelper.php b/application/Helper/GearmanWorkerHelper.php deleted file mode 100644 index 9cc403b9d..000000000 --- a/application/Helper/GearmanWorkerHelper.php +++ /dev/null @@ -1,248 +0,0 @@ -addServer($host, $port); - } - $this->logFile = get_log_file('deamon.log'); - } - - /** - * Will run jobs until $amount of jobs is processed. - * $timeout is used for to terminate if waiting for a new job takes too long - * Pass $timeout = 0 for no timeout - * - * @param int $amount Amount of jobs to process , Default: 1 - * @param int $timeout Time (in seconds) to spend waiting for jobs. , Default: 0 - no timeout. will wait infinitely - */ - public function doJobs($amount = 1, $timeout = 0) { - $amount = intval($amount); - $timeout = intval($timeout); - if ($amount == 0) { - $this->dbg('Running 0 jobs, exiting.'); - exit(0); - } - $originalAmount = $amount; - $this->setTimeout($timeout * 1000 + 100); - $keepWorking = true; - while ($keepWorking) { - if ($this->returnCode() === GEARMAN_TIMEOUT) { - $startTime = isset($startTime) ? $startTime : time(); - } - $this->dbg('Attempting to get job'); - $this->work(); - - if ($this->returnCode() === GEARMAN_TIMEOUT) { - $startTime = isset($startTime) ? $startTime : time(); - if (time() - $startTime >= $timeout) { - $this->dbg("Waited for a new job for $timeout seconds, giving up."); - // @todo notify admin that worker is going offline and use exit code 90 (expected) - exit(0); - } - } else if (in_array($this->returnCode(), array(GEARMAN_WORK_EXCEPTION, GEARMAN_SUCCESS, GEARMAN_WORK_FAIL))) { - - if(in_array($this->returnCode(), array(GEARMAN_WORK_EXCEPTION, GEARMAN_WORK_FAIL))) { - $this->dbg('GearmanError: ' . $this->error()); - } - - $this->dbg('Job complete'); - $amount -= 1; - if ($amount == 0) { - $this->dbg("Completed $originalAmount jobs"); - $keepWorking = false; - // sleep abit so that process can spawn again (notify admin) - sleep(10); - } - - } - } - $this->dbg('finished'); - } - - /** - * - * @param boolean $refresh - * @return GearmanClient - */ - protected function getGearmanClient($refresh = false) { - if ($this->gearmanClient === null || $refresh === true) { - $client = new GearmanClient(); - $servers = Config::get('deamon.gearman_servers'); - foreach ($servers as $server) { - list($host, $port) = explode(':', $server, 2); - $client->addServer($host, $port); - } - $this->gearmanClient = $client; - } - return $this->gearmanClient; - } - - /** - * Debug output - * - * @param string $str - * @param array $args - * @param Run $run - */ - protected function dbg($str, $args = array(), Run $run = null) { - if ($run !== null && is_object($run)) { - $logfile = get_log_file("cron/cron-run-{$run->name}.log"); - } else { - $logfile = $this->logFile; - } - - if (count($args) > 0) { - $str = vsprintf($str, $args); - } - - $str = join(" ", array( - date('Y-m-d H:i:s'), - get_class($this), - getmypid(), - $str, - PHP_EOL - )); - return error_log($str, 3, $logfile); - } - - protected function cleanup(Run $run = null) { - global $site; - if ($site->alerts) { - $this->dbg("\n
- Page %{page}/%{max_page}
-
-
-
-
- ';
- $buttons = '';
- for ($i = 1; $i < $pageNo; $i++) {
- $buttons .= Template::replace('%{page_no}', array(
- 'run_url' => $this->getPageUrl($i),
- 'page_no' => $i
- ));
- }
-
- return Template::replace($tpl, array(
- 'page' => $pageNo,
- 'max_page' => $this->getMaxPage(),
- 'name' => self::FMR_PAGE_ELEMENT,
- 'value' => $pageNo,
- 'buttons' => $buttons ? ' Back to Page ' . $buttons : null,
- 'progress_attributes' => implode(' ', $progressAttribs),
- ));
- }
-
- protected function emptyPreviousPageExists($pageNo) {
- $prev = $pageNo - 1;
- if ($prev < 1) {
- return false;
- }
-
- $query = array(
- 'survey_items_display.page <=' => $prev,
- 'survey_items_display.session_id' => $this->unitSession->id
- );
-
- $select = $this->db->select('survey_items_display.item_id, survey_items_display.page');
- $select->from('survey_items_display');
- $select->where($query);
- $select->where('survey_items_display.answered IS NULL');
- $select->order('survey_items_display.page', 'ASC');
- $select->limit(1);
- $row = $select->statement()->fetch(PDO::FETCH_ASSOC);
- if ($row) {
- return $row['page'];
- }
- return false;
- }
-
- /**
- * All items that don't require connecting to openCPU and don't require user input are posted immediately.
- * Examples: get parameters, browser, ip.
- *
- * @param Item[] $items
- * @return array Returns items that may have to be sent to openCPU or be rendered for user input
- */
- protected function processAutomaticItems($items) {
- $hiddenItems = array();
- foreach ($items as $name => $item) {
- if (!$item->needsDynamicValue() && !$item->requiresUserInput()) {
- $hiddenItems[$name] = $item->getComputedValue();
- //unset($items[$name]);
- continue;
- }
- }
-
- // save these values
- if ($hiddenItems) {
- $this->saveSuryeyItems($hiddenItems, false);
- }
-
- // return possibly shortened item array
- return $items;
- }
-
- /**
- * Process show-ifs and dynamic values for a given set of items in survey
- * @note: All dynamic values are processed (even for those we don't know if they will be shown)
- *
- * @param Item[] $items
- * @return array
- */
- protected function processDynamicValuesAndShowIfs(&$items) {
- // In this loop we gather all show-ifs and dynamic-values that need processing and all values.
- $code = array();
- $save = array();
-
- /* @var $item Item */
- foreach ($items as $name => &$item) {
- // 1. Check item's show-if
- $showif = $item->getShowIf();
- if ($showif) {
- $siname = "si.{$name}";
- $showif = str_replace("\n", "\n\t", $showif);
- $code[$siname] = "{$siname} = (function(){ \n {$showif} \n})()";
- }
-
- // 2. Check item's value
- if ($item->needsDynamicValue()) {
- $val = str_replace("\n", "\n\t", $item->getValue($this->survey));
- $code[$name] = "{$name} = (function(){ \n {$val} \n })()";
- if ($showif) {
- $code[$name] = "if({$siname}) { \n {$code[$name]} \n }";
- }
- // If item is to be shown (rendered), return evaluated dynamic value, else keep dynamic value as string
- }
- }
-
- if (!$code) {
- return $items;
- }
-
- $ocpu_session = opencpu_multiparse_showif($this->survey, $code, true);
- if (!$ocpu_session || $ocpu_session->hasError()) {
- notify_user_error(opencpu_debug($ocpu_session), "There was a problem evaluating showifs using openCPU.");
- foreach ($items as $name => &$item) {
- $item->alwaysInvalid();
- }
- } else {
- print_hidden_opencpu_debug_message($ocpu_session, "OpenCPU debugger for dynamic values and showifs.");
- $results = $ocpu_session->getJSONObject();
- $updateVisibility = $this->db->prepare("UPDATE `survey_items_display` SET hidden = :hidden WHERE item_id = :item_id AND session_id = :session_id");
- $updateVisibility->bindValue(":session_id", $this->unitSession->id);
-
- $definitelyShownItems = 0;
- foreach ($items as $item_name => &$item) {
- // set show-if visibility for items
- $siname = "si.{$item->name}";
- $isVisible = $item->setVisibility(array_val($results, $siname));
-
- // three possible states: 1 = hidden, 0 = shown, null = depends on JS on the page, render anyway
- if ($isVisible === null) {
- // we only render it, if there are some items before it on which its display could depend
- // otherwise it's hidden for good
- $hidden = $definitelyShownItems > 0 ? null : 1;
- } else {
- $hidden = (int) !$isVisible;
- }
- $item->hidden = $hidden;
- $updateVisibility->bindValue(':item_id', $item->id);
- $updateVisibility->bindValue(':hidden', $hidden);
- $updateVisibility->execute();
-
- if ($hidden === 1) { // gone for good
- //unset($items[$item_name]); // we remove items that are definitely hidden from consideration
- unset($item->parent_attributes['data-show']);
- $item->hidden = null;
- $item->hide();
- continue; // don't increment counter
- } else {
- // set dynamic values for items
- $val = array_val($results, $item->name, null);
- $item->setDynamicValue($val);
- // save dynamic value
- // if a. we have a value b. this item does not require user input (e.g. calculate)
- if (array_key_exists($item->name, $results) && !$item->requiresUserInput()) {
- $save[$item->name] = $item->getComputedValue();
- //unset($items[$item_name]); // we remove items that are immediately written from consideration
- continue; // don't increment counter
- }
- $this->markItemAsShown($item);
- }
- $definitelyShownItems++; // track whether there are any items certain to be shown
- }
- $this->saveSuryeyItems($save, false);
- }
-
- return $items;
- }
-
- protected function processDynamicLabelsAndChoices(&$items) {
- // Gather choice lists
- $lists_to_fetch = $strings_to_parse = array();
- $session_labels = array();
- foreach ($items as $name => &$item) {
- if ($item->choice_list) {
- $lists_to_fetch[] = $item->choice_list;
- }
-
- if ($item->needsDynamicLabel($this->survey)) {
- $items[$name]->label_parsed = opencpu_string_key(count($strings_to_parse));
- $strings_to_parse[] = $item->label;
- }
- }
-
- // gather and format choice_lists and save all choice labels that need parsing
- $choices = $this->survey->getChoices($lists_to_fetch, null);
- $choice_lists = array();
- foreach ($choices as $i => $choice) {
- if ($choice['label_parsed'] === null) {
- $choices[$i]['label_parsed'] = opencpu_string_key(count($strings_to_parse));
- $strings_to_parse[] = $choice['label'];
- }
-
- if (!isset($choice_lists[$choice['list_name']])) {
- $choice_lists[$choice['list_name']] = array();
- }
- $choice_lists[$choice['list_name']][$choice['name']] = $choices[$i]['label_parsed'];
- }
-
- // Now that we have the items and the choices, If there was anything left to parse, we do so here!
- if ($strings_to_parse) {
- $parsed_strings = opencpu_multistring_parse($this->survey, $strings_to_parse);
- // Replace parsed strings in $choice_list array
- opencpu_substitute_parsed_strings($choice_lists, $parsed_strings);
- // Replace parsed strings in unanswered items array
- opencpu_substitute_parsed_strings($items, $parsed_strings);
- }
-
- // Merge parsed choice lists into items
- foreach ($items as $name => &$item) {
- $choice_list = $item->choice_list;
- if (isset($choice_lists[$choice_list])) {
- $list = $choice_lists[$choice_list];
- $list = array_filter($list, 'is_formr_truthy');
- $items[$name]->setChoices($list);
- }
- $session_labels[$name] = $item->label_parsed;
- //$items[$name]->refresh($item, array('label_parsed'));
- }
-
- Session::set('labels', $session_labels);
- return $items;
- }
-
- /**
- * Mark as item as "to be shown"
- *
- * @param Item $item
- * @return Item
- */
- protected function markItemAsShown(&$item) {
- if ($item->hidden === 0) {
- $item->parent_attributes['data-show'] = true;
- }
- $item->data_showif = $item->js_showif ? true : false;
- return $item;
- }
-
- /**
- * Save Survey Items
- *
- * @param Item[] $items
- * @param boolean $validate
- */
- protected function saveSuryeyItems($items, $validate = true) {
- if (!$items) {
- return false;
- }
-
- if (!$validate) {
- foreach ($items as &$item) {
- if ($item instanceof Item) {
- $item->skip_validation = true;
- }
- }
- }
- return $this->survey->post($items, $validate);
- }
-
- /**
- * Checks if a displayed (rendered and visible) item exists in an array of items
- *
- * @param Item[] $items
- * @return boolean
- */
- protected function displayedItemExists(&$items) {
- foreach ($items as $item) {
- if ($item->isRendered() && !$item->hidden && $item->type !== 'submit') {
- return true;
- }
- }
- return false;
- }
-
- private function redirectToPage($page) {
- $redirect = $this->getPageUrl($page);
- redirect_to($redirect);
- }
-
- private function getPageUrl($page) {
- if ($page < 0) {
- $page = 1;
- }
- $params = array_diff_key($_REQUEST, $_POST);
- unset($params['route'], $params['run_name'], $params['code'], $params['_rsi_']);
- return run_url($this->run->name, $page, $params);
- }
-
-}
diff --git a/application/Helper/UserHelper.php b/application/Helper/UserHelper.php
new file mode 100644
index 000000000..1160b67cf
--- /dev/null
+++ b/application/Helper/UserHelper.php
@@ -0,0 +1,72 @@
+count('survey_users');
+ $pagination = new Pagination($count, 200, true);
+ $limits = $pagination->getLimits();
+ $where = " ";
+ if (!empty($params['email'])) {
+ $where = " WHERE email LIKE '%{$params['email']}%' ";
+ }
+
+ $itemsQuery = "
+ SELECT
+ `survey_users`.id,
+ `survey_users`.created,
+ `survey_users`.modified,
+ `survey_users`.email,
+ `survey_users`.admin,
+ `survey_users`.email_verified
+ FROM `survey_users`
+ {$where}
+ ORDER BY `survey_users`.id ASC LIMIT $limits
+ ";
+
+ $stmt = DB::getInstance()->prepare($itemsQuery);
+ $stmt->execute();
+
+ return array(
+ 'search_email' => $params['email'] ?? '',
+ 'pdoStatement' => $stmt,
+ 'pagination' => $pagination,
+ );
+ }
+
+ public static function getActiveUsersTablePdoStatement() {
+ $count = DB::getInstance()->count('survey_users');
+ $pagination = new Pagination($count, 200, true);
+ $limits = $pagination->getLimits();
+
+ $itemsQuery = "
+ SELECT
+ `survey_users`.id,
+ `survey_users`.created,
+ `survey_users`.modified,
+ `survey_users`.email,
+ `survey_users`.admin,
+ `survey_users`.email_verified,
+ `survey_runs`.name AS run_name,
+ `survey_runs`.cron_active,
+ `survey_runs`.public,
+ COUNT(`survey_run_sessions`.id) AS number_of_users_in_run,
+ MAX(`survey_run_sessions`.last_access) AS last_edit
+ FROM `survey_users`
+ LEFT JOIN `survey_runs` ON `survey_runs`.user_id = `survey_users`.id
+ LEFT JOIN `survey_run_sessions` ON `survey_runs`.id = `survey_run_sessions`.run_id
+ WHERE `survey_users`.admin > 0
+ GROUP BY `survey_runs`.id
+ ORDER BY `survey_users`.id ASC, last_edit DESC LIMIT $limits
+ ";
+
+ $stmt = DB::getInstance()->prepare($itemsQuery);
+ $stmt->execute();
+
+ return array(
+ 'pdoStatement' => $stmt,
+ 'pagination' => $pagination,
+ );
+ }
+
+}
diff --git a/application/Library/AnimalName.php b/application/Library/AnimalName.php
deleted file mode 100644
index 637260b98..000000000
--- a/application/Library/AnimalName.php
+++ /dev/null
@@ -1,600 +0,0 @@
-findFile($class)) {
- if (class_exists($class, false)) {
- return true;
- }
-
- include $file;
- if (!class_exists($class)) {
- $message = sprintf("Autloader expected class %s to be defined in file %s. The file was found but the class was not in it", $class, $file);
- throw new RuntimeException($message);
- }
- return true;
- }
- return false;
- }
-
- /**
- * Finds the path associated to the class name
- *
- * @param string $class
- * @return string|null
- */
- private function findFile($class) {
- if (!defined('APPLICATION_ROOT')) {
- define('APPLICATION_ROOT', realpath(dirname(__FILE__) . '../../') . '/');
- }
-
- if (!defined('APPLICATION_PATH')) {
- define('APPLICATION_PATH', APPLICATION_ROOT . 'application/');
- }
-
- $class = $this->classNameToPath($class);
- $libraryPath = APPLICATION_PATH . "Library/{$class}.php";
- $modelPath = APPLICATION_PATH . "Model/{$class}.php";
-
- if (strstr($class, 'Controller') !== false) {
- $file = APPLICATION_PATH . "Controller/{$class}.php";
- } elseif (strstr($class, 'Helper') !== false) {
- $file = APPLICATION_PATH . "Helper/{$class}.php";
- } elseif (file_exists($modelPath)) {
- $file = $modelPath;
- } elseif (file_exists($libraryPath)) {
- $file = $libraryPath;
- }
-
- if (!empty($file)) {
- return $file;
- }
- return false;
- }
-
- protected function classNameToPath($class) {
- if (strstr($class, '_') !== false) {
- $pieces = array_reverse(explode('_', $class));
- $class = implode('/', $pieces);
- }
- if (substr($class, -7) === 'Factory') {
- $class = str_replace('Factory', '', $class);
- }
- return $class;
- }
-
- public static function getLoader() {
- if (self::$loader === null) {
- /* @var $loader Autoload */
- $loader = new self();
- $loader->register();
- self::$loader = $loader;
- }
- return self::$loader;
- }
-
-}
-
-return Autoload::getLoader();
diff --git a/application/Library/CURL.php b/application/Library/CURL.php
deleted file mode 100644
index 709b7113d..000000000
--- a/application/Library/CURL.php
+++ /dev/null
@@ -1,389 +0,0 @@
- 20,
- // The maximum number of seconds to allow cURL functions to execute.
- CURLOPT_TIMEOUT => 120,
- // TRUE to return the transfer as a string of the return value of
- // curl_exec() instead of outputting it out directly.
- CURLOPT_RETURNTRANSFER => 1,
- // TRUE to follow any "Location: " header that the server sends as part
- // of the HTTP header (note this is recursive, PHP will follow as many
- // "Location: " headers that it is sent, unless CURLOPT_MAXREDIRS is
- // set).
- CURLOPT_FOLLOWLOCATION => true,
- // FALSE to stop cURL from verifying the peer's certificate.
- // Alternate certificates to verify against can be specified with the
- // CURLOPT_CAINFO option or a certificate directory can be specified
- // with the CURLOPT_CAPATH option. CURLOPT_SSL_VERIFYHOST may also need
- // to be TRUE or FALSE if CURLOPT_SSL_VERIFYPEER is disabled (it defaults to 2)
- CURLOPT_SSL_VERIFYPEER => true,
- // 1 to check the existence of a common name in the SSL peer certificate.
- // 2 to check the existence of a common name and also verify that it matches the hostname provided.
- CURLOPT_SSL_VERIFYHOST => 2,
- // The contents of the "User-Agent: " header to be used in a HTTP request.
- CURLOPT_USERAGENT => self::USERAGENT,
- );
-
- /**
- * Create cURL resource initialized with common options
- * Requires curl php extension to be present
- *
- * Parameters in POST method can be passed in two modes:
- * - application/x-www-form-urlencoded
- * - multipart/form-data
- * Default is 'multipart/form-data'
- *
- * While PHP can parse both modes just fine, certain servers accept only one. One such example is Twitter API.
- * To enforce encoding with 'application/x-www-form-urlencoded', pass parameters as string, like 'para1=val1¶2=val2&...'
- * See {@link http://php.net/manual/en/function.curl-setopt.php curl_setopt} for CURLOPT_POSTFIELDS.
- *
- * @static
- * @throws Exception
- * @param string $url url to request
- * @param array $params request parameters (GET or POST)
- * @param string $method http method (GET/POST)
- * @param array $options curl extra options
- * @param array $info = null curl_getinfo() results stored here
- * @return string content
- */
- public static function HttpRequest($url, $params = array(), $method = self::HTTP_METHOD_GET, $options = array(), &$info = null) {
- static $have_curl;
- if ($have_curl === null) {
- $have_curl = extension_loaded('curl');
- }
- if ($have_curl === false) {
- throw new Exception("cURL extension not loaded.");
- }
-
- $curl = curl_init();
- if ($curl === false) {
- throw new Exception("Unable to initialize cURL.");
- }
-
- if (!$options) {
- $options = array();
- }
-
- $curlConfigOptions = Config::get('curl', array());
- $curlConfigOptions += self::$curlOptions;
- $options += $curlConfigOptions;
-
- if ($method == self::HTTP_METHOD_POST) {
- $options[CURLOPT_POST] = true;
- $options[CURLOPT_POSTFIELDS] = $params;
- } elseif ($method === self::HTTP_METHOD_PUT) {
- $options[CURLOPT_RETURNTRANSFER] = true;
- $options[CURLOPT_CUSTOMREQUEST] = self::HTTP_METHOD_PUT;
- } elseif ($method == self::HTTP_METHOD_GET || $method == self::HTTP_METHOD_HEAD) {
- if ($method == self::HTTP_METHOD_GET) {
- $options[CURLOPT_HTTPGET] = true;
- } else if ($method == self::HTTP_METHOD_HEAD) {
- // make HEAD request
- $options[CURLOPT_NOBODY] = true;
- // enable header to capture response headers
- $options[CURLOPT_HEADER] = true;
- }
-
- if ($params) {
- if (!is_array($params)) {
- // undefined how you pass key=value pairs with params being 'string'.
- throw new LogicException("Can't do GET and params of type '" . gettype($params) . "', use POST instead");
- }
- $url = self::urljoin($url, $params);
- }
- }
- $options[CURLOPT_URL] = $url;
- curl_setopt_array($curl, $options);
-// curl_setopt($curl, CURLOPT_HTTPHEADER,array("Expect:"));
- $res = curl_exec($curl);
- $info = curl_getinfo($curl);
-
- if ($res === false) {
- $error = curl_error($curl);
- curl_close($curl);
- throw new Exception("cURL error: {$error} in {$info['total_time']}");
- }
- curl_close($curl);
-
- // convert to array in case of headers wanted
- $return = $res;
- if (!empty($options[CURLOPT_HEADER])) {
- $info[self::RESPONSE_HEADERS] = self::chopHttpHeaders($res, $info);
- $return = substr($return, $info['header_size']);
- }
-
- return $return;
- }
-
- /**
- * Retrieve URL using cURL. Decodes resonse as JSON.
- *
- * @param string $url url to download
- * @param array $params request parameters (GET or POST)
- * @param string $method http method (GET/POST)
- * @param array $options curl extra options
- * @param array &$info curl_getinfo() results stored here
- * @param bool $assoc [optional] When true, returned objects will be converted into associative arrays.
- * @throws Exception when url can't be retrieved or json does not parse
- * @return object
- */
- public static function JsonRequest($url, $params = array(), $method = self::HTTP_METHOD_GET, $options = array(), &$info = null, $assoc = false) {
- $res = self::HttpRequest($url, $params, $method, $options, $info);
-
- $json = json_decode($res, $assoc);
- // we'll assume nobody wants to return NULL
- if ($json === null) {
- if (function_exists('json_last_error_msg')) {
- // PHP 5.5
- $error = json_last_error_msg();
- } elseif (function_exists('json_last_error')) {
- // PHP 5.3
- $error = 'error code ' . json_last_error();
- } else {
- $error = 'no more info available';
- }
- throw new Exception('Unable decode json response from [' . $url . '][http code ' . $info['http_code'] . ']: ' . $error);
- }
-
- return $json;
- }
-
- /**
- * Append parameters to URL. URL may already contain parameters.
- *
- * $quote_style = ENT_QUOTES for '&' to became '&'
- * $quote_style = ENT_NOQUOTES for '&' to became '&'
- *
- * @static
- * @param $url
- * @param array $params
- * @param int $quote_style = ENT_NOQUOTES
- * @return string
- */
- public static function urljoin($url, $params = array(), $quote_style = ENT_NOQUOTES) {
- if ($params) {
- $amp = $quote_style == ENT_QUOTES ? '&' : '&';
- $args = http_build_query($params, null, $amp);
- if ($args) {
- $q = strstr($url, '?') ? $amp : '?';
- $url .= $q . $args;
- }
- }
-
- return $url;
- }
-
- /**
- *
- * @param type $filename
- * @param type $postname
- * @return mixed Returns a string if CURLFile class is not present else returns an instance of curl file
- *
- * @todo Detect mime type automatically
- */
- public static function getPostFileParam($filename, $postname = 'filename') {
- if (class_exists('CURLFile', false)) {
- return new CURLFile($filename, null, $postname);
- }
- return "@$filename";
- }
-
- /**
- * Download file from URL using cURL. The file is streamed so it does not occupy lots of memory for large downloads.
- * File is downloaded to temporary file and renamed on success. on failure temporary file is cleaned up.
- *
- * @param string $url url to download
- * @param string $output_file path there to save the result
- * @param Array $ params request parameters (GET or POST)
- * @param string $method http method (GET/POST)
- * @param array $options curl extra options
- * @param array &$info curl_getinfo() results stored here
- * @throws Exception
- */
- public static function DownloadUrl($url, $output_file, $params = array(), $method = self::HTTP_METHOD_GET, $options = array(), &$info = null) {
- $last_modified = null;
-
- // if content filters present check those first
- if (isset($options[self::DOWNLOAD_FILTERS])) {
- // make copy of filters, do not pass it in real HttpRequest
- $filters = $options[self::DOWNLOAD_FILTERS];
- unset($options[self::DOWNLOAD_FILTERS]);
-
- // pre-check with HEAD request
- self::HttpRequest($url, $params, self::HTTP_METHOD_HEAD, $options, $info);
-
- // extract Last-Modified header to save timestamp later
- if (!empty($filters[self::DOWNLOAD_FILTER_KEEP_LAST_MODIFIED])) {
- if (isset($info[self::RESPONSE_HEADERS]['Last-Modified'])) {
- $last_modified = strtotime($info[self::RESPONSE_HEADERS]['Last-Modified']);
- }
- }
-
- if (isset($filters[self::DOWNLOAD_FILTER_CONTENT_TYPE])) {
- if (empty($info['content_type'])) {
- throw new Exception("Didn't get Content-Type from HEAD request");
- }
- if (!in_array($info['content_type'], $filters[self::DOWNLOAD_FILTER_CONTENT_TYPE])) {
- throw new Exception("Wrong Content-Type: {$info['content_type']}");
- }
- }
-
- if (isset($filters[self::DOWNLOAD_FILTER_MAXSIZE])) {
- if (empty($info['download_content_length'])) {
- throw new Exception("Didn't get Content-Length from HEAD request");
- }
- // TODO: handle -1
- // http://stackoverflow.com/questions/5518323/curl-getinfo-returning-1-as-content-length
- if ($info['download_content_length'] > $filters[self::DOWNLOAD_FILTER_MAXSIZE]) {
- throw new Exception("File too large: {$info['download_content_length']} bytes");
- }
- }
- }
-
- $tmpfile = tempnam(dirname($output_file), basename($output_file));
- $fp = fopen($tmpfile, 'wb+');
- if ($fp == false) {
- throw new Exception("Failed to create: $tmpfile");
- }
-
- // set defaults for this method
- $options += array(
- CURLOPT_TIMEOUT => 10 * 60,
- );
-
- // overrride, must be this or the method will fail
- $options[CURLOPT_RETURNTRANSFER] = false;
- $options[CURLOPT_FILE] = $fp;
-
- $res = self::HttpRequest($url, $params, $method, $options, $info);
- if (fclose($fp) !== true) {
- throw new Exception("Unable to save download result");
- }
-
- if ($res !== true) {
- unlink($tmpfile);
- throw new Exception("Download error (in {$info['total_time']})");
- }
-
- // expect 2xx status code
- if ($info['http_code'] < 200 || $info['http_code'] > 300) {
- unlink($tmpfile);
- throw new Exception($url . ': bad statuscode ' . $info['http_code'], $info['http_code']);
- }
-
- // restore timestamp, if available
- if ($last_modified) {
- touch($tmpfile, $last_modified);
- }
-
- $rename = rename($tmpfile, $output_file);
- if ($rename !== true) {
- throw new Exception("Unable to rename temporary file");
- }
- }
-
- /**
- * Parse HTTP Headers out of cURL $response, it modifies $response while doing so
- *
- * Uses header splitter from
- * {@link http://www.sitepoint.com/forums/showthread.php?590248-Getting-response-header-in-PHP-cURL-request here}
- *
- * @param string $response
- * @param array $info
- * @return array
- */
- private static function chopHttpHeaders(&$response, &$info) {
- $headerstext = substr($response, 0, $info['header_size']);
- $info['raw_header'] = $headerstext;
-
- // 'download_content_length' is -1 for HEAD request
- if ($info['download_content_length'] >= 0) {
- $response = substr($response, -$info['download_content_length']);
- } else {
- $response = '';
- }
- $headersets = explode("\r\n\r\n", $headerstext);
-
- // http_parse_headers() php implementation from here:
- // http://php.net/manual/en/function.http-parse-headers.php
- $res = null;
- foreach ($headersets as $i => $headerset) {
- if (empty($headerset)) {
- continue;
- }
-
- $headerlist = explode("\r\n", $headerset);
- $headers = array();
- // fill status line as 'Status' header, it's identical to what 'Status' actual header would be used in CGI scripts
- $headers['Status'] = array_shift($headerlist);
- foreach ($headerlist as $line) {
- $line = rtrim($line);
- if (empty($line)) {
- continue;
- }
-
- list($header, $value) = preg_split('/:\s*/', $line, 2);
-
- // Do Camel-Case to header name
- $header = str_replace(" ", "-", ucwords(strtolower(str_replace("-", " ", $header))));
-
- // add as array if duplicate
- if (isset($headers[$header])) {
- $headers[$header] = array($headers[$header], $value);
- } else {
- $headers[$header] = $value;
- }
- }
-
- if (isset($res)) {
- $headers[self::RESPONSE_PREVIOUS_HEADERS] = $res;
- }
- $res = $headers;
- }
-
- return $res;
- }
-
-}
diff --git a/application/Library/Cache.php b/application/Library/Cache.php
deleted file mode 100644
index 0549ea568..000000000
--- a/application/Library/Cache.php
+++ /dev/null
@@ -1,80 +0,0 @@
- PDO::PARAM_INT,
- 'integer' => PDO::PARAM_INT,
- // String Types
- 'str' => PDO::PARAM_STR,
- 'string' => PDO::PARAM_STR,
- // Boolean types
- 'bool' => PDO::PARAM_BOOL,
- 'boolean' => PDO::PARAM_BOOL,
- // NULL type
- 'null' => PDO::PARAM_NULL,
- );
-
- /**
- * Default data-type
- *
- * @var interger
- */
- protected $default_type = PDO::PARAM_STR;
-
- /**
- * Get a DB instance
- *
- * @return DB
- */
- public static function getInstance() {
- if (self::$instance == null) {
- self::$instance = new self();
- }
- return self::$instance;
- }
-
- /**
- * @var PDO
- */
- protected $PDO;
-
- protected function __construct() {
- $params = (array) Config::get('database');
-
- $options = array(
- 'host' => $params['host'],
- 'dbname' => $params['database'],
- 'charset' => 'utf8',
- );
- if (!empty($params['port'])) {
- $options['port'] = $params['port'];
- }
-
- $dsn = 'mysql:' . http_build_query($options, null, ';');
- $this->PDO = new PDO($dsn, $params['login'], $params['password'], array(
- PDO::ATTR_EMULATE_PREPARES => false,
- PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
- PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
- ));
-
- $dt = new DateTime();
- $offset = $dt->format("P");
-
- $this->PDO->exec("SET time_zone='$offset';");
- $this->PDO->exec("SET SESSION sql_mode='STRICT_ALL_TABLES';");
- }
-
- /**
- * Execute any query with parameters and get results
- *
- * @param string $query Query string with optional placeholders
- * @param array $params An array of parameters to bind to PDO statement
- * @param bool $fetchcol
- * @param bool $fetchrow
- * @return array Returns an associative array of results
- */
- public function execute($query, $params = array(), $fetchcol = false, $fetchrow = false) {
- $data = self::parseWhereBindParams($params);
- $params = $data['params'];
- $stmt = $this->PDO->prepare($query);
- $stmt->execute($params);
- if ($fetchcol) {
- return $stmt->fetchColumn();
- }
- if ($fetchrow) {
- return $stmt->fetch(PDO::FETCH_ASSOC);
- }
- return $stmt->fetchAll(PDO::FETCH_ASSOC);
- }
-
- /**
- * Used for INSERT, UPDATE and DELETE
- *
- * @param string $query MySQL query with placeholders
- * @param array $data Optional associative array of parameters that will be bound to the query
- * @return int Returns the number of affected rows of the query
- */
- public function exec($query, array $data = array()) {
- if ($data) {
- $data = self::parseWhereBindParams($data);
- $params = $data['params'];
- $sth = $this->PDO->prepare($query);
- $sth->execute($params);
- return $sth->rowCount();
- }
- return $this->PDO->exec($query);
- }
-
- /**
- * Used for SELECT or 'non-modify' queries
- *
- * @param string $query SQL query to execute
- * @param bool $return_statemnt [optional] If set to true, PDOStatement is always returned
- * @return mixed Returns a PDOStatement if not selecting else returns selected results in an associative array
- */
- public function query($query, $return_statemnt = false) {
- $stmt = $this->PDO->query($query);
- if (preg_match('/^select/', strtolower($query)) && $return_statemnt === false) {
- return $stmt->fetchAll(PDO::FETCH_ASSOC);
- }
- return $stmt;
- }
-
- /**
- * @param string $query
- *
- * @return PDOStatement
- */
- public function rquery($query) { //secured query with prepare and execute
- $args = func_get_args();
- array_shift($args); //first element is not an argument but the query itself, should removed
-
- $stmt = $this->PDO->prepare($query);
- $stmt->execute($args);
- return $stmt;
- }
-
- /**
- * Get the number of rows in a result
- *
- * @param string $query
- * @return mixed
- */
- public function num_rows($query) {
- # create a prepared statement
- $stmt = $this->PDO->prepare($query);
- $stmt->execute();
- return $stmt->rowCount();
- }
-
- public function table_exists($table) {
- return $this->num_rows("SHOW TABLES LIKE '" . $table . "'") > 0;
- }
-
- public function __destruct() {
- $this->PDO = null;
- }
-
- public function getError() {
- return $this->PDO->errorInfo();
- }
-
- /**
- * Find a set of records from db
- *
- * @param string $table_name
- * @param string|aray $where
- * @param array $params
- * @return array
- */
- public function find($table_name, $where = null, $params = array()) {
- if (empty($params['cols'])) {
- $params['cols'] = array();
- }
- $select = $this->select($params['cols']);
- $select->from($table_name);
-
- if ($where) {
- $select->where($where);
- }
-
- if (!empty($params['order']) && !empty($params['order_by'])) {
- $select->order($params['order_by'], $params['order']);
- }
-
- if (!empty($params['limit'])) {
- $offset = isset($params['offset']) ? $params['offset'] : 0;
- $select->limit($params['limit'], $offset);
- }
-
- // unset all the shit that is not necessary for binding
- unset($params['cols'], $params['order_by'], $params['order'], $params['limit'], $params['offset']);
- if ($params) {
- $params = self::parseWhereBindParams($params);
- $select->setParams($params['binds']);
- }
-
- return $select->fetchAll();
- }
-
- public function findRow($table_name, $where = null, $cols = array()) {
- return $this->select($cols)->from($table_name)->where($where)->limit(1)->fetch();
- }
-
- public function findValue($table_name, $where = null, $cols = array()) {
- return $this->select($cols)->from($table_name)->where($where)->limit(1)->fetchColumn();
- }
-
- public function select($cols = array()) {
- if (is_string($cols)) {
- $cols = explode(',', $cols);
- }
- return new DB_Select($this->PDO, $cols);
- }
-
- /**
- * Count
- *
- * @param string $table_name
- * @param array|string $where If a string is given, it must be properly escaped
- * @param string $col specify some column name to count
- * @return int
- */
- public function count($table_name, $where = array(), $col = '*') {
- $query = "SELECT count({$col}) FROM {$table_name}";
- $params = array();
- if ($where && is_array($where)) {
- $wc = self::parseWhereBindParams($where);
- $query .= " WHERE {$wc['clauses_str']}";
- $params = $wc['params'];
- } elseif ($where && is_string($where)) {
- $query .= " WHERE $where";
- }
-
- $stmt = $this->PDO->prepare($query);
- $stmt->execute($params);
- return $stmt->fetchColumn();
- }
-
- /**
- * Assert the existence of rows in a table
- *
- * @param string $table_name
- * @param array|string $where If a string is given, it must be properly escaped
- * @return boolean
- */
- public function entry_exists($table_name, $where) {
- return $this->count($table_name, $where) > 0;
- }
-
- /**
- * Insert Data into a MySQL Table
- *
- * @param string $table_name Table Name
- * @param array $data An associative array of data with keys representing column names
- * @param array $types A numerically indexed array representing the data-types of the value in the $data array.
- * @throws Exception
- * @return mix Returns an integer if last insert id was set else returns null
- */
- public function insert($table_name, array $data, array $types = array()) {
- if (!$this->checkTypeCount($data, $types)) {
- throw new Exception("Array count for data and data-types do not match");
- }
-
- $keys = array_map(array('DB', 'pkey'), array_keys($data));
- $cols = array_map(array('DB', 'quoteCol'), array_keys($data));
-
- $query = self::replace("INSERT INTO %{table_name} (%{cols}) VALUES (%{values})", array(
- 'cols' => implode(', ', $cols),
- 'values' => implode(', ', $keys),
- 'table_name' => $table_name,
- ));
-
- /* @var $stmt PDOStatement */
- $stmt = $this->PDO->prepare($query);
- $stmt = $this->bindValues($stmt, $data, array_values($types), false, true);
- $stmt->execute();
- return $this->lastInsertId();
- }
-
- /**
- * Insert data and update values on duplicate keys
- *
- * @param string $table Table name
- * @param array $data An associative array of key,value pairs representing data to insert
- * @param array $updates [optional] Optional column names representing what values to update
- * @return int Returns number of affected rows
- */
- public function insert_update($table, array $data, array $updates = array()) {
- $columns = array_map(array('DB', 'quoteCol'), array_keys($data));
- $values = array_map(array('DB', 'pkey'), array_keys($data));
- if (!$updates) {
- $updates = array_keys($data);
- }
- $table = self::quoteCol($table);
-
- $columns_str = implode(',', $columns);
- $values_str = implode(',', $values);
- $updates_str = $this->getDuplicateUpdateString($updates);
-
- $query = "INSERT INTO $table ($columns_str) VALUES ($values_str) ON DUPLICATE KEY UPDATE $updates_str";
- return $this->exec($query, $data);
- }
-
- public function update($table_name, array $data, array $where, array $data_types = array(), array $where_types = array()) {
- if (!$this->checkTypeCount($data, $data_types)) {
- throw new Exception("Array count for data and data-types do not match");
- }
-
- if (!$this->checkTypeCount($where, $where_types)) {
- throw new Exception("Array count for where clause and where clause data-types do not match");
- }
-
- // remove signs from where clauses (<, >, <= , >=, != can be used in array keys of $where array. E.g $where['id >'] = 45)
- $cols_where = array_keys($where);
- $signs = array();
- foreach ($cols_where as $i => $col_condition) {
- $col_condition = trim($col_condition);
- $col_condition = preg_replace('/\s+/', ' ', $col_condition);
- $parts = array_filter(explode(' ', $col_condition));
- if (count($parts) === 1) {
- $signs[$i] = '=';
- } else {
- $signs[$i] = $parts[1];
- }
- $cols_where[$i] = $parts[0];
- }
-
- $cols = array_map(array('DB', 'quoteCol'), array_keys($data));
- $cols_where = array_map(array('DB', 'quoteCol'), $cols_where);
- $set_values = $where_values = array();
-
- foreach ($cols as $col) {
- $set_values[] = "$col = ?";
- }
-
- foreach ($cols_where as $i => $col) {
- $sign = !empty($signs[$i]) ? $signs[$i] : '=';
- $where_values[] = "$col $sign ?";
- }
-
- $query = self::replace("UPDATE %{table_name} SET %{set_values} WHERE (%{where_values})", array(
- 'where_values' => implode(' AND ', $where_values),
- 'set_values' => implode(', ', $set_values),
- 'table_name' => $table_name,
- ));
-
- /* @var $stmt PDOStatement */
- $stmt = $this->PDO->prepare($query);
- $stmt = $this->bindValues($stmt, $data, array_values($data_types), true, true);
- $stmt = $this->bindValues($stmt, $where, array_values($where_types));
- $stmt->execute();
- return $stmt->rowCount();
- }
-
- public function delete($table_name, array $data, array $types = array()) {
- $cols = array_map(array('DB', 'pCol'), array_keys($data));
- $query = self::replace("DELETE FROM %{table_name} WHERE (%{values})", array(
- 'values' => implode(' AND ', $cols),
- 'table_name' => self::quoteCol($table_name),
- ));
-
- /* @var $stmt PDOStatement */
- $stmt = $this->PDO->prepare($query);
- $stmt = $this->bindValues($stmt, $data, array_values($types), false, true);
- $stmt->execute();
- return $stmt->rowCount();
- }
-
- /**
- * @param string $query
- * @param array $options [optional] driver options
- * @return PDOStatement
- */
- public function prepare($query, $options = array()) {
- return $this->PDO->prepare($query, $options);
- }
-
- /**
- * Quote a string for sql query
- *
- * @param string $string
- * @return string
- */
- public function quote($string) {
- return $this->PDO->quote($string);
- }
-
- /**
- * @return PDO
- */
- public function pdo() {
- return $this->PDO;
- }
-
- public function lastInsertId() {
- return $this->PDO->lastInsertId();
- }
-
- /**
- *
- * @param PDOStatement $stmt
- * @param array $data
- * @param array $types
- * @param bool $numeric
- * #param bool $reset
- * @return PDOStatement
- */
- private function bindValues($stmt, $data, $types, $numeric = true, $reset = false) {
- static $i;
- if ($reset || $i === null) {
- $i = 0;
- }
- foreach ($data as $key => $value) {
- $type = $this->default_type;
- if (isset($types[$i]) && isset($this->types[$types[$i]])) {
- $type = $this->types[$types[$i]];
- }
- $stmt->bindValue(($numeric ? $i + 1 : self::pkey($key)), $value, $type);
- $i++;
- }
- return $stmt;
- }
-
- private function checkTypeCount(array $data, array $types) {
- if (!$types) {
- return true;
- }
- return count($types) === count($data);
- }
-
- public function getDuplicateUpdateString($columns) {
- foreach ($columns as $i => $column) {
- if (is_numeric($i)) {
- $column = trim($column, '`');
- $columns[$i] = "`$column` = VALUES(`$column`)";
- } else {
- $value = $this->PDO->quote($column);
- $column = trim($i, '`');
- $columns[$i] = "`$column` = $value";
- }
- }
- return implode(', ', $columns);
- }
-
- public static function pkey($key) {
- $key = trim($key);
- $key = trim($key, '`:');
- return ':' . $key;
- }
-
- public static function pCol($col) {
- $col = trim($col);
- $col = trim($col, '`:');
- $col = "`$col` = :$col";
- return $col;
- }
-
- public static function quoteCol($col, $table = null) {
- $col = trim($col);
- $col = trim($col, '`');
- return $table !== null ? "`$table`.`$col`" : "`$col`";
- }
-
- public static function parseColName($string) {
- if (strpos($string, '.') !== false) {
- $string = explode('.', $string, 2);
- $tableName = self::quoteCol($string[0]);
- $fieldName = self::quoteCol($string[1]);
- return $tableName . '.' . $fieldName;
- }
- return self::quoteCol($string);
- }
-
- public static function parseWhereBindParams(array $array) {
- $cols = array_keys($array);
- $values = array_values($array);
-
- $clauses = array_map(array('DB', 'pCol'), $cols);
- $params = array();
-
- foreach ($cols as $i => $col) {
- $params[self::pkey($col)] = $values[$i];
- }
- return array(
- 'clauses' => $clauses,
- 'clauses_str' => implode(' AND ', $clauses),
- 'params' => $params,
- );
- }
-
- public static function replace($string, $params = array()) {
- foreach ($params as $key => $value) {
- $key = "%{" . $key . "}";
- $string = str_replace($key, $value, $string);
- }
- return $string;
- }
-
- /**
- * For transactions just use same calls
- */
-
- /**
- * {inherit PDO doc}
- */
- public function beginTransaction() {
- return $this->PDO->beginTransaction();
- }
-
- /**
- * {inherit PDO doc}
- */
- public function commit() {
- return $this->PDO->commit();
- }
-
- /**
- * {inherit PDO doc}
- */
- public function rollBack() {
- return $this->PDO->rollBack();
- }
-
- public function getTableDefinition($table, $property = null) {
- $query = "SHOW COLUMNS FROM `$table`";
- $stmt = $this->PDO->query($query);
- $cols = $stmt->fetchAll(PDO::FETCH_ASSOC);
- if ($property === null) {
- return $cols;
- }
- $filtered = array();
- foreach ($cols as $col) {
- $filtered[$col[$property]] = $col;
- }
- return $filtered;
- }
-
-}
-
-class DB_Select {
-
- /**
- * @var PDO
- */
- protected $PDO;
-
- /**
- * Constructed SQL statement
- *
- * @var string
- */
- protected $query;
- protected $where = array();
- protected $or_where = array();
- protected $joins = array();
- protected $columns = array('*');
- protected $params = array();
- protected $order = array();
- protected $limit;
- protected $offset;
- protected $table;
-
- public function __construct(PDO $pdo, array $cols = array()) {
- $this->PDO = $pdo;
- $this->columns($cols);
- }
-
- public function __destruct() {
- $this->PDO = null;
- }
-
- public function columns(array $cols) {
- if ($cols) {
- $this->columns = $this->parseCols($cols);
- }
- }
-
- public function from($table) {
- $this->table = DB::quoteCol($table);
- return $this;
- }
-
- public function leftJoin($table, $condition) {
- $table = DB::quoteCol($table);
- $condition = $this->parseJoinConditions(func_get_args());
- $this->joins[] = " LEFT JOIN $table ON ($condition)";
- return $this;
- }
-
- public function rightJoin($table, $condition) {
- $table = DB::quoteCol($table);
- $condition = $this->parseJoinConditions(func_get_args());
- $this->joins[] = " RIGHT JOIN $table ON ($condition)";
- return $this;
- }
-
- public function join($table, $condition) {
- $table = DB::quoteCol($table);
- $condition = $this->parseJoinConditions(func_get_args());
- $this->joins[] = " INNER JOIN $table ON ($condition)";
- return $this;
- }
-
- public function where($where) {
- if (is_array($where)) {
- $whereParsed = $this->parseWhere($where);
- $this->where = array_merge($this->where, $whereParsed['clauses']);
- $this->params = array_merge($this->params, $whereParsed['params']);
- } elseif (is_string($where)) {
- $this->where[] = $where;
- }
- return $this;
- }
-
- public function whereIn($field, array $values) {
- $field = $this->parseColName($field);
- $values = array_map(array($this->PDO, 'quote'), $values);
- $this->where[] = "{$field} IN (" . implode(',', $values) . ")";
- }
-
- public function like($colname, $value, $pad = 'both') {
- $colname = $this->parseColName($colname);
- if ($pad === 'right') {
- $value = "$value%";
- } elseif ($pad === 'left') {
- $value = "%$value";
- } else {
- $value = "%$value%";
- }
- $this->PDO->quote($value);
- $this->where("$colname LIKE '$value'");
- return $this;
- }
-
- public function limit($limit, $offset = 0) {
- $this->limit = (int) $limit;
- $this->offset = (int) $offset;
- return $this;
- }
-
- public function order($by, $order = 'asc') {
- if ($by === 'RAND') {
- $this->order[] = 'RAND()';
- return $this;
- }
-
- if ($order === null) {
- $this->order[] = $by;
- return $this;
- }
-
- $order = strtoupper($order);
- if (!in_array($order, array('ASC', 'DESC'))) {
- throw new Exception("Invalid Order");
- }
- $by = $this->parseColName($by);
- $this->order[] = "$by $order";
- return $this;
- }
-
- /**
- * {inherit PDO doc}
- */
- public function fetchAll($fetch_style = PDO::FETCH_ASSOC) {
- $this->constructQuery();
- $query = $this->trimQuery();
- $stmt = $this->PDO->prepare($query);
- $stmt->execute($this->params);
- return $stmt->fetchAll($fetch_style);
- }
-
- /**
- * {inherit PDO doc}
- */
- public function fetch($fetch_style = PDO::FETCH_ASSOC) {
- $this->constructQuery();
- $query = $this->trimQuery();
- $stmt = $this->PDO->prepare($query);
- $stmt->execute($this->params);
- return $stmt->fetch($fetch_style);
- }
-
- /**
- * {inherit PDO doc}
- */
- public function fetchColumn() {
- $this->constructQuery();
- $query = $this->trimQuery();
- $stmt = $this->PDO->prepare($query);
- $stmt->execute($this->params);
- return $stmt->fetchColumn();
- }
-
- /**
- * Returns executed PDO statement of current query
- *
- * @return PDOStatement
- */
- public function statement() {
- $this->constructQuery();
- $query = $this->trimQuery();
- $stmt = $this->PDO->prepare($query);
- if ($this->params) {
- foreach ($this->params as $key => $value) {
- $stmt->bindValue($key, $value);
- }
- }
- $stmt->execute();
- return $stmt;
- }
-
- public function getParams() {
- return $this->params;
- }
-
- public function setParams(array $params) {
- $this->params = $params;
- return $this;
- }
-
- public function bindParams(array $params) {
- $params = $this->parseWhere($params);
- $this->params = array_merge($this->params, $params['params']);
- return $this;
- }
-
- public function lastQuery() {
- $this->constructQuery();
- return $this->query;
- }
-
- private function trimQuery() {
- return str_replace("\n", "", $this->query);
- }
-
- /**
- * @todo Add or_where and or_like clauses
- */
- private function constructQuery() {
- $columns = implode(', ', $this->columns);
-
- $query = "SELECT $columns FROM {$this->table} \n";
- if ($this->joins) {
- $query .= implode(" \n", $this->joins);
- }
-
- if ($this->where) {
- $where = implode(' AND ', $this->where);
- $query .= " WHERE ($where)";
- }
-
- if ($this->order) {
- $order = implode(', ', $this->order);
- $query .= " \nORDER BY " . $order;
- }
-
- if ($this->limit) {
- $query .= " \nLIMIT {$this->offset}, {$this->limit}";
- }
- $this->query = $query;
- }
-
- private function parseJoinConditions($conditions) {
- array_shift($conditions); // first arguement is the table name
- $parsed = array();
- foreach ($conditions as $condition) {
- $parsed[] = $this->parseJoinCondition($condition);
- }
- return implode(' AND ', $parsed);
- }
-
- private function parseJoinCondition($condition) {
- $conditions = explode('=', $condition, 2);
- if (count($conditions) != 2) {
- throw new Exception("Unable to get join condition clauses");
- }
- $conditions = $this->parseCols($conditions);
- return implode(' = ', $conditions);
- }
-
- private function parseCols(array $cols) {
- $select = array();
- foreach ($cols as $key => $val) {
- if (is_numeric($key)) {
- $select[] = $this->parseColName($val);
- } else {
- $select[] = $this->parseColName($key) . ' AS ' . $this->parseColName($val);
- }
- }
- return $select;
- }
-
- private function parseColName($string) {
- $string = trim($string);
- // If the column is not one of these then maybe some mysql func or so is called
- if (preg_match('/[^a-zA-Z0-9_\.\`]/i', $string, $matches)) {
- return $string;
- }
-
- $string = trim($string, '`');
-
- if (strpos($string, '.') !== false) {
- $string = explode('.', $string, 2);
- $tableName = DB::quoteCol($string[0]);
- $fieldName = DB::quoteCol($string[1]);
- return $tableName . '.' . $fieldName;
- }
- return DB::quoteCol($string);
- }
-
- private function parseWhere(array $array) {
- $cols = array_keys($array);
- $values = array_values($array);
-
- $signs = array();
- foreach ($cols as $i => $col_condition) {
- $col_condition = preg_replace('/\s+/', ' ', trim($col_condition));
- $parts = array_filter(explode(' ', $col_condition));
- if (count($parts) === 1) {
- $signs[$i] = '=';
- } else {
- $signs[$i] = $parts[1];
- }
- $cols[$i] = $parts[0];
- }
-
- $clauses = array(); //array_map(array('DB', 'pCol'), $cols);
- $params = array();
- foreach ($cols as $i => $col) {
- $sign = !empty($signs[$i]) ? $signs[$i] : '=';
- $param = $col;
- if (strstr($col, '.') !== false) {
- list($c, $param) = explode('.', $col, 2);
- }
- $col = $this->parseColName($col);
- $clauses[] = "$col $sign :$param";
- $params[DB::pkey($param)] = $values[$i];
- }
-
- return array(
- 'clauses' => $clauses,
- 'params' => $params,
- );
- }
-
-}
diff --git a/application/Library/Deamon.php b/application/Library/Deamon.php
deleted file mode 100644
index 0ccce643f..000000000
--- a/application/Library/Deamon.php
+++ /dev/null
@@ -1,232 +0,0 @@
-db = $db;
- $this->lockFile = APPLICATION_ROOT . 'tmp/deamon.lock';
- $this->runExpireTime = Config::get('deamon.run_expire_time', 10 * 60);
- $this->loopInterval = Config::get('deamon.loop_interval', 60);
-
- // Register signal handlers that should be able to kill the cron in case some other weird shit happens
- // apart from cron exiting cleanly
- // declare signal handlers
- if (extension_loaded('pcntl')) {
- declare(ticks = 1);
-
- pcntl_signal(SIGINT, array(&$this, 'interrupt'));
- pcntl_signal(SIGTERM, array(&$this, 'interrupt'));
- pcntl_signal(SIGUSR1, array(&$this, 'interrupt'));
- } else {
- self::$dbg = true;
- self::dbg('pcntl extension is not loaded');
- }
- }
-
- public function run() {
- $runExpireTime = $time = $id = 0;
- $fetchStmt = $this->db->prepare('select id, name, last_deamon_access from survey_runs where last_deamon_access < :run_expiration_time and cron_active = 1 order by rand()');
- $fetchStmt->bindParam(':run_expiration_time', $runExpireTime, PDO::PARAM_INT);
-
- $updateStmt = $this->db->prepare('update survey_runs set last_deamon_access = :time where id = :id');
- $updateStmt->bindParam(':time', $time);
- $updateStmt->bindParam(':id', $id);
-
- // loop forever until terminated by SIGINT
- while (!$this->out) {
- try {
- file_put_contents($this->lockFile, date('r'));
- // loop until terminated but with taking some nap
- while (!$this->out && $this->rested()) {
-
- $runExpireTime = time() - $this->runExpireTime;
- $fetchStmt->execute();
- $runs = $fetchStmt->fetchAll(PDO::FETCH_ASSOC);
- $gearmanClient = $this->getGearmanClient();
-
- if (!$runs) {
- self::dbg('No runs to be processed at this time.. waiting to retry');
- sleep(10);
- continue;
- }
-
- foreach ($runs as $run) {
- $time = time();
- $id = $run['id'];
- self::dbg("Process run '%s'. Last access: %s", $run['name'], date('r', $run['last_deamon_access']));
- $updateStmt->execute();
- $gearmanClient->doHighBackground('process_run', json_encode($run), $run['name']);
- }
-
- }
- } catch (Exception $e) {
- // if connection disappeared - try to restore it
- $error_code = $e->getCode();
- if ($error_code != 1053 && $error_code != 2006 && $error_code != 2013 && $error_code != 2003) {
- throw $e;
- }
-
- self::dbg($e->getMessage() . "[" . $error_code . "]");
-
- self::dbg("Unable to connect. waiting 5 seconds before reconnect.");
- sleep(5);
- }
- }
-
- echo getmypid(), " Terminating...\n";
- }
-
- public function cronize() {
- $time = $id = null;
- $fetchStmt = $this->db->prepare('select id, name, last_deamon_access from survey_runs where cron_active = 1 order by rand()');
- $updateStmt = $this->db->prepare('update survey_runs set last_deamon_access = :time where id = :id');
- $updateStmt->bindParam(':time', $time);
- $updateStmt->bindParam(':id', $id);
-
- $fetchStmt->execute();
- $runs = $fetchStmt->fetchAll(PDO::FETCH_ASSOC);
-
- if (!$runs) {
- self::dbg('No runs to be processed at this time.. waiting to retry');
- return;
- }
-
- $gearmanClient = $this->getGearmanClient();
- foreach ($runs as $run) {
- $time = time();
- $id = $run['id'];
- self::dbg("Process run [cr.d] '%s'. Last access: %s", $run['name'], date('r', $run['last_deamon_access']));
- $updateStmt->execute();
- $gearmanClient->doHighBackground('process_run', json_encode($run), $run['name']);
- }
- }
-
- /**
- * Signal handler
- *
- * @param integer $signo
- */
- public function interrupt($signo) {
- switch ($signo) {
- // Set terminated flag to be able to terminate program securely
- // to prevent from terminating in the middle of the process
- // Use Ctrl+C to send interruption signal to a running program
- case SIGINT:
- case SIGTERM:
- $this->out = true;
- self::dbg("%s Received termination signal", getmypid());
- $this->cleanup('SIGINT|SIGTERM');
- break;
-
- // switch the debug mode on/off
- // @example: $ kill -s SIGUSR1 "; - - if (DEBUG || ($run_session && !$run_session->isCron() && $run_session->isTesting()) ) { - if ($error instanceof Exception) { - $message .= $error->getMessage(); - } else { - $message .= $error; - } - } - alert($message, 'alert-danger'); -} - -function print_hidden_opencpu_debug_message($ocpu_req, $public_message = '') { - $run_session = Site::getInstance()->getRunSession(); - if (DEBUG || ($run_session && !$run_session->isCron() && $run_session->isTesting()) ) { - $date = date('Y-m-d H:i:s'); - - $message = $date . ': ' . $public_message . "
"; - - $message .= opencpu_debug($ocpu_req); - alert($message, 'alert-info hidden_debug_message hidden'); - } -} - -function redirect_to($location = '', $params = array()) { - $location = str_replace(PHP_EOL, '', $location); - if (strpos($location, 'index') !== false) { - $location = ''; - } - - if (mb_substr($location, 0, 4) != 'http') { - $base = WEBROOT; - if (mb_substr($location, 0, 1) == '/') { - $location = $base . mb_substr($location, 1); - } else { - $location = $base . $location; - } - } - if ($params) { - $location .= '?' . http_build_query($params); - } - - Session::globalRefresh(); - Session::over(); - header("Location: $location"); - exit; -} - -function session_over($site, $user) { - static $closed; - if ($closed) { - return false; - } -/* - $_SESSION['site'] = $site; - $_SESSION['user'] = serialize($user); -*/ - session_write_close(); - $closed = true; - return true; -} - -function access_denied() { -/* - global $site, $user; - $_SESSION['site'] = $site; - $_SESSION['user'] = serialize($user); -*/ - redirect_to('error/403'); -} - -function not_found() { -/* - global $site, $user; - $_SESSION['site'] = $site; - $_SESSION['user'] = serialize($user); -*/ - redirect_to('error/404'); -} - -function bad_request() { -/* - global $site, $user; - $_SESSION['site'] = $site; - $_SESSION['user'] = serialize($user); -*/ - redirect_to('error/500'); -} - -function bad_request_header() { - header('HTTP/1.0 500 Bad Request'); -} - -function formr_error($code = 500, $title = 'Bad Request', $text = 'Request could not be processed', $hint = null, $link = null, $link_text = null) { - $code = $code ? $code : 500; - header("HTTP/1.0 {$code} {$title}"); - if ($link === null) { - $link = site_url(); - } - - if ($link_text === null) { - $link_text = 'Go to Site'; - } - - if (php_sapi_name() == 'cli') { - echo date('r') . " Error {$code}: {$text} \n"; - exit; - } - - Template::load('public/error', array( - 'code' => $code, - 'title' => $hint ? $hint : $title, - 'text' => $text, - 'link' => $link, - 'link_text' => $link_text, - )); - exit; -} - -function json_header() { - header('Content-Type: application/json'); -} - -function is_ajax_request() { - return strtolower(env('HTTP_X_REQUESTED_WITH')) === 'xmlhttprequest'; -} - -function h($text) { - return htmlspecialchars($text); -} - -function debug($string) { - if (DEBUG) { - echo "
"; - print_r($string); - echo ""; - } -} - -function pr($string, $log = false) { - if (DEBUG > 0 && !$log) { - echo "
"; - var_dump($string); - echo ""; - } else { - formr_log(print_r($string, true)); - } -} - -function prb($string = null) { - static $output = ""; - if ($string === null) { - if (DEBUG > 0) { - echo "
"; - var_dump($string); - # print_r( debug_backtrace()); - echo ""; - } else { - formr_log($string); - } - } else { - $output .= "
" . $string; - } -} - -if (!function_exists('_')) { - - function _($text) { - return $text; - } - -} - -function used_opencpu($echo = false) { - static $used; - if ($echo): - pr("Requests: " . $used); - return $used; - endif; - if (isset($used)) { - $used++; - } else { - $used = 1; - } - return $used; -} - -function used_cache($echo = false) { - static $used; - if ($echo): - pr("Hashcache: " . $used); - return $used; - endif; - if (isset($used)) { - $used++; - } else { - $used = 1; - } - return $used; -} - -function used_nginx_cache($echo = false) { - static $used; - if ($echo): - pr("Nginx: " . $used); - return $used; - endif; - if (isset($used)) { - $used++; - } else { - $used = 1; - } - return $used; -} - -if (!function_exists('__')) { - - /** - taken from cakePHP - */ - function __($singular, $args = null) { - if (!$singular) { - return; - } - - $translated = _($singular); - if ($args === null) { - return $translated; - } elseif (!is_array($args)) { - $args = array_slice(func_get_args(), 1); - } - return vsprintf($translated, $args); - } - -} - -if (!function_exists('__n')) { - - /** - taken from cakePHP - */ - function __n($singular, $plural, $count, $args = null) { - if (!$singular) { - return; - } - - $translated = ngettext($singular, $plural, null, 6, $count); - if ($args === null) { - return $translated; - } elseif (!is_array($args)) { - $args = array_slice(func_get_args(), 3); - } - return vsprintf($translated, $args); - } - -} - -function endsWith($haystack, $needle) { - $length = strlen($needle); - if ($length == 0) { - return true; - } - - return (mb_substr($haystack, -$length) === $needle); -} - -/** - * Gets an environment variable from available sources, and provides emulation - * for unsupported or inconsistent environment variables (i.e. DOCUMENT_ROOT on - * IIS, or SCRIPT_NAME in CGI mode). Also exposes some additional custom - * environment information. - * - * @param string $key Environment variable name. - * @return string Environment variable setting. - * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#env - */ -function env($key) { - if ($key === 'HTTPS') { - if (isset($_SERVER['HTTPS'])) { - return (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off'); - } - return (mb_strpos(env('SCRIPT_URI'), 'https://') === 0); - } - - if ($key === 'SCRIPT_NAME') { - if (env('CGI_MODE') && isset($_ENV['SCRIPT_URL'])) { - $key = 'SCRIPT_URL'; - } - } - - $val = null; - if (isset($_SERVER[$key])) { - $val = $_SERVER[$key]; - } elseif (isset($_ENV[$key])) { - $val = $_ENV[$key]; - } elseif (getenv($key) !== false) { - $val = getenv($key); - } - - if ($key === 'REMOTE_ADDR' && $val === env('SERVER_ADDR')) { - $addr = env('HTTP_PC_REMOTE_ADDR'); - if ($addr !== null) { - $val = $addr; - } - } - - if ($val !== null) { - return $val; - } - - switch ($key) { - case 'SCRIPT_FILENAME': - if (defined('SERVER_IIS') && SERVER_IIS === true) { - return str_replace('\\\\', '\\', env('PATH_TRANSLATED')); - } - break; - case 'DOCUMENT_ROOT': - $name = env('SCRIPT_NAME'); - $filename = env('SCRIPT_FILENAME'); - $offset = 0; - if (!mb_strpos($name, '.php')) { - $offset = 4; - } - return mb_substr($filename, 0, -(strlen($name) + $offset)); - case 'PHP_SELF': - return str_replace(env('DOCUMENT_ROOT'), '', env('SCRIPT_FILENAME')); - case 'CGI_MODE': - return (PHP_SAPI === 'cgi'); - case 'HTTP_BASE': - $host = env('HTTP_HOST'); - $parts = explode('.', $host); - $count = count($parts); - - if ($count === 1) { - return '.' . $host; - } elseif ($count === 2) { - return '.' . $host; - } elseif ($count === 3) { - $gTLD = array( - 'aero', - 'asia', - 'biz', - 'cat', - 'com', - 'coop', - 'edu', - 'gov', - 'info', - 'int', - 'jobs', - 'mil', - 'mobi', - 'museum', - 'name', - 'net', - 'org', - 'pro', - 'tel', - 'travel', - 'xxx' - ); - if (in_array($parts[1], $gTLD)) { - return '.' . $host; - } - } - array_shift($parts); - return '.' . implode('.', $parts); - } - return null; -} - -function emptyNull(&$x) { - $x = ($x == '') ? null : $x; -} - -function stringBool($x) { - if ($x === false) { - return 'false'; - } elseif ($x === true) { - return 'true'; - } elseif ($x === null) { - return 'null'; - } elseif ($x === 0) { - return '0'; - } elseif(is_array($x) AND empty($x)) { - return "NA"; - } - - return $x; -} - -function hardTrueFalse($x) { - if ($x === false) { - return 'FALSE'; - } elseif ($x === true) { - return 'TRUE'; -# elseif($x===null) return 'NULL'; - } elseif ($x === 0) { - return '0'; - } - - return $x; -} - -if (!function_exists('http_parse_headers')) { - - function http_parse_headers($raw_headers) { - $headers = array(); - $key = ''; // [+] - - foreach (explode("\n", $raw_headers) as $i => $h) { - $h = explode(':', $h, 2); - - if (isset($h[1])) { - if (!isset($headers[$h[0]])) { - $headers[$h[0]] = trim($h[1]); - } elseif (is_array($headers[$h[0]])) { - // $tmp = array_merge($headers[$h[0]], array(trim($h[1]))); // [-] - // $headers[$h[0]] = $tmp; // [-] - $headers[$h[0]] = array_merge($headers[$h[0]], array(trim($h[1]))); // [+] - } else { - // $tmp = array_merge(array($headers[$h[0]]), array(trim($h[1]))); // [-] - // $headers[$h[0]] = $tmp; // [-] - $headers[$h[0]] = array_merge(array($headers[$h[0]]), array(trim($h[1]))); // [+] - } - - $key = $h[0]; // [+] - } else { // [+] // [+] - if (mb_substr($h[0], 0, 1) == "\t") { // [+] - $headers[$key] .= "\r\n\t" . trim($h[0]); // [+] - } elseif (!$key) { // [+] - $headers[0] = trim($h[0]); // [+] - } - } // [+] - } - - return $headers; - } - -} - -/** - * Format a timestamp to display its age (5 days ago, in 3 days, etc.). - * - * @param int $timestamp - * @return string - */ -function timetostr($timestamp) { - if ($timestamp === false) { - return ""; - } - $age = time() - $timestamp; - - $future = ($age <= 0); - $age = abs($age); - - $age = (int) ($age / 60); // minutes ago - if ($age == 0) { - return $future ? "a moment" : "just now"; - } - - $scales = [ - ["minute", "minutes", 60], - ["hour", "hours", 24], - ["day", "days", 7], - ["week", "weeks", 4.348214286], // average with leap year every 4 years - ["month", "months", 12], - ["year", "years", 10], - ["decade", "decades", 10], - ["century", "centuries", 1000], - ["millenium", "millenia", PHP_INT_MAX] - ]; - - foreach ($scales as $scale) { - list($singular, $plural, $factor) = $scale; - if ($age == 0) { - return $future ? "less than 1 $singular" : "less than 1 $singular ago"; - } - if ($age == 1) { - return $future ? "1 $singular" : "1 $singular ago"; - } - if ($age < $factor) { - return $future ? "$age $plural" : "$age $plural ago"; - } - - $age = (int) ($age / $factor); - } -} - -// from http://de1.php.net/manual/en/function.filesize.php -function human_filesize($bytes, $decimals = 2) { - $sz = 'BKMGTP'; - $factor = floor((strlen($bytes) - 1) / 3); - return sprintf("%.{$decimals}f", $bytes / pow(1024, $factor)) . @$sz[$factor]; -} - -function cr2nl($string) { - return str_replace("\r\n", "\n", $string); -} - -function time_point($line, $file) { - static $times, $points; - if (empty($times)) { - $times = array($_SERVER["REQUEST_TIME_FLOAT"]); - $points = array("REQUEST TIME " . round($_SERVER["REQUEST_TIME_FLOAT"] / 60, 6)); - } - $took = $times[count($times) - 1]; - $times[] = microtime(true); - $took = round(($times[count($times) - 1] - $took) / 60, 6); - $points[] = "took $took minutes to get to line " . $line . " in file: " . $file; - return $points; -} - -function echo_time_points($points) { -// echo ""; -} - -function crypto_token($length, $url = true) { - $bytes = openssl_random_pseudo_bytes($length, $crypto_strong); - $base64 = base64_url_encode($bytes); - if (!$crypto_strong) { - formr_error(500, 'Internal Server Error', 'Generated cryptographic tokens are not strong.', 'Cryptographic Error'); - } - return $base64; -} - -function base64_url_encode($data) { - return strtr(base64_encode($data), '+/=', '-_~'); -} - -function base64_url_decode($data) { - return base64_decode(strtr($data, '-_~', '+/=')); -} - -/** - * Create URL Title - * - * Takes a "title" string as input and creates a - * human-friendly URL string with a "separator" string - * as the word separator. - * - * @param string the string - * @param string the separator - * @param strin $lowercase Should string be returned in lowecase letters - * @return string - */ -function url_title($str, $separator = '-', $lowercase = false) { - if ($separator == 'dash') { - $separator = '-'; - } else if ($separator == 'underscore') { - $separator = '_'; - } - $q_separator = preg_quote($separator); - $trans = array( - '&.+?;' => '', - '[^a-z0-9 _-]' => '', - '\s+' => $separator, - '(' . $q_separator . ')+' => $separator - ); - $str = strip_tags($str); - foreach ($trans as $key => $val) { - $str = preg_replace("#" . $key . "#i", $val, $str); - } - - if ($lowercase === true) { - $str = strtolower($str); - } - - return trim($str, $separator); -} - -function empty_column($col, $arr) { - $empty = true; - $last = null; - foreach ($arr AS $row): - if (!(empty($row->$col)) OR // not empty column? (also treats 0 and empty strings as empty) - $last != $row->$col OR // any variation in this column? - ! (!is_array($row->$col) AND trim($row->$col) == '')): - $empty = false; - break; - endif; - $last = $row->$col; - endforeach; - return $empty; -} - -/** - * Return an array of contents in the run export directory - * - * @param string $dir Absolute path to readable directory - * @return mixed Returns an array if all is well or FALSE otherwise - */ -function get_run_dir_contents($dir) { - if (!$dir || !is_dir($dir) || !is_readable($dir)) { - return false; - } - - $files = glob($dir . '/*.json'); - if (!$files) { - return false; - } - - $contents = array(); - foreach ($files as $file) { - $file_contents = file_get_contents($file); - $json = json_decode($file_contents); - if ($json) { - $contents[basename($file)] = $json->name; - } - } - return $contents; -} - -/** - * Get the mime type of a file given filename using FileInfo - * @see http://php.net/manual/en/book.fileinfo.php - * - * @param string $filename - * @return mixed Returns the mime type as a string or FALSE otherwise - */ -function get_file_mime($filename) { - $constant = defined('FILEINFO_MIME_TYPE') ? FILEINFO_MIME_TYPE : FILEINFO_MIME; - $finfo = finfo_open($constant); - $info = finfo_file($finfo, $filename); - finfo_close($finfo); - $mime = explode(';', $info); - if (!$mime) { - return false; - } - - $mime_type = $mime[0]; - return $mime_type; -} - -/** - * Send a file for download to client - * - * @param string $file Absolute path to file - * @param boolean $unlink - * @todo implement caching stuff - */ -function download_file($file, $unlink = false) { - $type = get_file_mime($file); - $filename = basename($file); - $filesize = filesize($file); - header('Content-Description: File Transfer'); - header('Content-Type: ' . $type); - header('Content-Disposition: attachment; filename = "' . $filename . '"'); - header('Content-Transfer-Encoding: binary'); - header('Expires: 0'); - header('Cache-Control: must-revalidate, post-check=0, pre-check=0'); - if ($filesize) { - header('Content-Length: ' . $filesize); - } - readfile($file); - if ($unlink) { - unlink($file); - } - exit(0); -} - -/** - * @deprecated - */ -function get_duplicate_update_string($columns) { - foreach ($columns as $i => $column) { - $column = trim($column, '`'); - $columns[$i] = "`$column` = VALUES(`$column`)"; - } - return $columns; -} - -/** - * Returns a valid MySQL datetime string - * - * @param int $time [optional] Valid unix timestamp - * @return string - */ -function mysql_datetime($time = null) { - if ($time === null) { - $time = time(); - } - return date('Y-m-d H:i:s', $time); -} - -/** - * Returns a string equivalent to MySQL's NOW() function - * - * @return string - */ -function mysql_now() { - return mysql_datetime(); -} - -/** - * Returns formatted strings equivalent to expressions like NOW() + INTERVAL 2 DAY - * - * @param string A string defining an interval accepted by PHP's strtotime() function - * @return string - */ -function mysql_interval($interval) { - if (($time = strtotime($interval)) === false) { - throw new Exception("Invalid time interval given to strtotime '$interval'"); - } - return mysql_datetime($time); -} - -function site_url($uri = '', $params = array()) { - $url = WEBROOT; - if ($uri) { - $url .= $uri . '/'; - } - if ($params) { - $url .= '?' . http_build_query($params); - } - return trim($url, '\/\\'); -} - -function admin_url($uri = '', $params = array()) { - if ($uri) { - $uri = '/' . $uri; - } - return site_url('admin' . $uri, $params); -} - -function run_url($name = '', $action = '', $params = array()) { - if ($name === Run::TEST_RUN) { - return site_url('run/' . $name . '/' . $action); - } - - $protocol = Config::get('define_root.protocol'); - $domain = trim(Config::get('define_root.doc_root'), "\/\\"); - $subdomain = null; - if (Config::get('use_study_subdomains')) { - $subdomain = strtolower($name) . '.'; - } else { - $domain .= '/' . $name; - } - $url = $protocol . $subdomain . $domain; - if ($action) { - $action = trim($action, "\/\\"); - $url .= '/' . $action . '/'; - } - if ($params) { - $url .= '?' . http_build_query($params); - } - return $url; -} - -function admin_study_url($name = '', $action = '', $params = array()) { - if ($action) { - $name = $name . '/' . $action; - } - return admin_url('survey/' . $name, $params); -} - -function admin_run_url($name = '', $action = '', $params = array()) { - if ($action) { - $name = $name . '/' . $action; - } - return admin_url('run/' . $name, $params); -} - - -/** -* modified from https://stackoverflow.com/questions/118884/what-is-an-elegant-way-to-force-browsers-to-reload-cached-css-js-files?rq=1 - * Given a file, i.e. /css/base.css, replaces it with a string containing the - * file's mtime, i.e. /css/base.1221534296.css. - * - * @param $file The file to be loaded. Must not start with a slash. - */ -function asset_url($file) { - if (strpos($file, 'http') !== false || strpos($file, '//') === 0) { - return $file; - } - if (strpos($file, 'assets') === false) { - $file = 'assets/' . $file; - } - $mtime = @filemtime(APPLICATION_ROOT . "webroot/" . $file); - if(!$mtime) { - return site_url($file); - } - return site_url($file . "?v" . $mtime); -} - -function monkeybar_url($run_name, $action = '', $params = array()) { - return run_url($run_name, 'monkey-bar/' . $action, $params); -} - -function array_to_accordion($array) { - $rand = mt_rand(0, 10000); - $acc = '
';
- $first = ' in';
-
- foreach ($array as $title => $content):
- if ($content == null) {
- $content = stringBool($content);
- }
- $id = 'collapse' . str_replace(' ', '', $rand . $title);
-
- $acc .= '
-
';
- return $acc;
-}
-
-function array_to_orderedlist($array, $olclass = null, $liclass = null) {
- $ol = '
-
-
';
- $first = '';
- endforeach;
-
- $acc .= '
-
-
- ' . $content . '
-
- - ';
- foreach ($array as $title => $label) {
- if (is_formr_truthy($label)) {
- $ol .= '
- ' . $label . ' '; - } - } - $ol .= '
- '; - } elseif(isset($params['x'])) { - $debug['R Code'] = ' - Download R code file to debug.
- '; - } - if ($session->hasError()) { - $debug['Response'] = pre_htmlescape($session->getError()); - } else { - if($session->getFiles("knit.html")) { - $iframesrc = $session->getFiles("knit.html")['knit.html']; - $debug['Response'] = ' - '; - } - else if (isset($params['text']) || $rtype === 'text') { - $debug['Response'] = stringBool($session->getObject('text')); - } else { - $debug['Response'] = pre_htmlescape(json_encode($session->getJSONObject(), JSON_PRETTY_PRINT + JSON_UNESCAPED_UNICODE)); - } - } - - $urls = $session->getResponsePathsAsLinks(); - if (!$session->hasError() AND ! empty($urls)) { - $locations = ''; - foreach ($urls AS $path => $link) { - $path = str_replace('/ocpu/tmp/' . $session->getKey(), '', $path); - $locations .= "$path
"; - } - $debug['Locations'] = $locations; - } - $debug['Session Info'] = pre_htmlescape($session->getInfo()); - $debug['Session Console'] = pre_htmlescape($session->getConsole()); - $debug['Session Stdout'] = pre_htmlescape($session->getStdout()); - $debug['Request'] = pre_htmlescape((string) $request); - - $reponse_headers = $session->getResponseHeaders(); - $debug['Response Headers'] = pre_htmlescape(print_r($reponse_headers, 1)); - - $reponse_info = $session->caller()->getRequestInfo(); - $debug['Request Headers'] = pre_htmlescape(print_r($reponse_info['request_header'], 1)); - } catch (Exception $e) { - $debug['Response'] = 'An error occured: ' . $e->getMessage(); - } - } - - return array_to_accordion($debug); -} - -function opencpu_log($msg) { - $log = ''; - if ($msg instanceof Exception) { - $log .= $msg->getMessage() . "\n" . $msg->getTraceAsString(); - } else { - $log .= $msg; - } - error_log($log . "\n", 3, get_log_file('opencpu.log')); -} - -function pre_htmlescape($str) { - return '
' . htmlspecialchars($str) . ''; -} - -function array_val($array, $key, $default = "") { - if (!is_array($array)) { - return false; - } - if (array_key_exists($key, $array)) { - return $array[$key]; - } - return $default; -} - -function shutdown_formr_org() { - $user = Site::getCurrentUser(); - if (is_object($user) && $user->cron) { - return; - } - - $error = error_get_last(); - if($error !== null && $error['type'] === E_ERROR && !DEBUG) { - $errno = $error["type"]; - $errfile = $error["file"]; - $errline = $error["line"]; - $errstr = $error["message"]; - - $msg = "A fatal error occured and your request could not be completed. Contact site admins with these details \n"; - $msg .= "Error [$errno] in $errfile line $errline \n $errstr"; - //alert($msg, 'alert-danger'); - - formr_error(500, 'Internal Server Error', nl2br($msg), 'Fatal Error'); - } -} - -function remove_tag_wrapper($text, $tag = 'p') { - $text = trim($text); - if (preg_match("@^<{$tag}>(.+)$@", $text, $matches)) { - $text = isset($matches[1]) ? $matches[1] : $text; - } - return $text; -} - -function delete_tmp_file($file) { - // unlink tmp file especially for the case of google sheets - if (!empty($file['tmp_name']) && file_exists($file['tmp_name'])) { - @unlink($file['tmp_name']); - } -} - -/** - * Hackathon to dwnload an excel sheet from google - * - * @param string $survey_name - * @param string $google_link The URL of the Google Sheet - * @return array|boolean Returns an array similar to that of an 'uploaded-php-file' or FALSE otherwise; - */ -function google_download_survey_sheet($survey_name, $google_link) { - $google_id = google_get_sheet_id($google_link); - if (!$google_id) { - return false; - } - - $destination_file = Config::get('survey_upload_dir') . '/googledownload-' . $google_id . '.xlsx'; - $google_download_link = "http://docs.google.com/spreadsheets/d/{$google_id}/export?format=xlsx&{$google_id}"; - $info = array(); - - try { - if (!is_writable(dirname($destination_file))) { - throw new Exception("The survey backup directory is not writable"); - } - $options = array( - CURLOPT_SSL_VERIFYHOST => 0, - CURLOPT_SSL_VERIFYPEER => 0, - ); - - CURL::DownloadUrl($google_download_link, $destination_file, null, CURL::HTTP_METHOD_GET, $options, $info); - if (empty($info['http_code']) || $info['http_code'] < 200 || $info['http_code'] > 302 || strstr($info['content_type'], "text/html") !== false) { - $link = google_get_sheet_link($google_id); - throw new Exception("The google sheet at {$link} could not be downloaded. Please make sure everyone with the link can access the sheet!"); - } - - $ret = array( - 'name' => $survey_name . '.xlsx', - 'tmp_name' => $destination_file, - 'size' => filesize($destination_file), - 'google_id' => $google_id, - 'google_link' => google_get_sheet_link($google_id), - 'google_download_link' => $google_download_link, - ); - } catch (Exception $e) { - formr_log_exception($e, 'CURL_DOWNLOAD', $google_link); - alert($e->getMessage(), 'alert-danger'); - $ret = false; - } - return $ret; -} - -/** - * preg-match the Google sheet ID from the google sheet link - * - * @param string $link - * @return string|null - */ -function google_get_sheet_id($link) { - $matches = array(); - preg_match('/spreadsheets\/d\/(.*)\/edit/', $link, $matches); - if (!empty($matches[1])) { - return $matches[1]; - } - return null; -} - -/** - * Returns the google sheet link given ID - * - * @param string $id - * @return string - */ -function google_get_sheet_link($id) { - return "https://docs.google.com/spreadsheets/d/{$id}/edit"; -} - -function strt_replace($str, $params) { - foreach ($params as $key => $value) { - $str = str_replace('%{'.$key.'}', $value, $str); - $str = str_replace('{'.$key.'}', $value, $str); - } - return $str; -} - -function fill_array($array, $value = '') { - foreach ($array as $key => $v) { - $array[$key] = $value; - } - return $array; -} - -function files_are_equal($a, $b) { - if (!file_exists($a) || !file_exists($b)) - return false; - - // Check if filesize is different - if (filesize($a) !== filesize($b)) - return false; - - if (sha1_file($a) !== sha1_file($b)) - return false; - - return true; -} - -function create_zip_archive($files, $destination, $overwrite = false) { - $zip = new ZipArchive(); - - if ($zip->open($destination, $overwrite ? ZIPARCHIVE::OVERWRITE : ZIPARCHIVE::CREATE) !== true) { - return false; - } - - //add the files - foreach($files as $file) { - if (is_file($file)) { - $zip->addFile($file, basename($file)); - } - } - $zip->close(); - - //check to make sure the file exists - return file_exists($destination); -} - -function create_ini_file($assoc, $filepath) { - file_put_contents($filepath, ''); - foreach ($assoc as $section => $fields) { - file_put_contents($filepath, "[{$section}]\n", FILE_APPEND); - foreach ($fields as $key => $value) { - file_put_contents($filepath, "{$key} = {$value}\n", FILE_APPEND); - } - file_put_contents($filepath, "\n", FILE_APPEND); - } - return file_exists($filepath); -} - -function deletefiles($files) { - foreach($files as $file) { - if(is_file($file)) { - @unlink($file); - } - } -} - -function get_default_assets($config = 'site') { - if (DEBUG) { - return Config::get("default_assets.dev.{$config}"); - } else { - return Config::get("default_assets.prod.{$config}"); - } -} - -function get_assets() { - return get_default_assets('assets'); -} - -function print_stylesheets($files, $id = null) { - foreach ($files as $i => $file) { - $id = 'css-' . $i . $id; - echo '' . "\n"; - } -} - -function print_scripts($files, $id = null) { - foreach ($files as $i => $file) { - $id = 'js-' . $i . $id; - echo '' . "\n"; - } -} - -function fwrite_json($handle, $data) { - if ($handle) { - fseek($handle, 0, SEEK_END); - if (ftell($handle) > 0) { - fseek($handle, -1, SEEK_END); - fwrite($handle, ',', 1); - fwrite($handle, "\n" . json_encode($data) . "]"); - } else { - fwrite($handle, json_encode(array($data))); - } - } -} - -function do_run_shortcodes($text, $run_name, $sess_code) { - $link_tpl = '%{text}'; - if ($run_name) { - $login_url = run_url($run_name, null, array('code' => $sess_code)); - $logout_url = run_url($run_name, 'logout', array('code' => $sess_code)); - $settings_url = run_url($run_name, 'settings', array('code' => $sess_code)); - } else { - $login_url = $settings_url = site_url(); - $logout_url = site_url('logout'); - //alert("Generated a login link, but no run was specified", 'alert-danger'); - } - - - $settings_link = Template::replace($link_tpl, array('url' => $settings_url, 'text' => 'Settings Link')); - $login_link = Template::replace($link_tpl, array('url' => $login_url, 'text' => 'Login Link')); - $logout_link = Template::replace($link_tpl, array('url' => $logout_url, 'text' => 'Logout Link')); - - $text = str_replace("{{login_link}}", $login_link, $text); - $text = str_replace("{{login_url}}", $login_url, $text); - $text = str_replace("{{login_code}}", urlencode($sess_code), $text); - $text = str_replace("{{settings_link}}", $settings_link, $text); - $text = str_replace("{{settings_url}}", $settings_url, $text); - $text = str_replace("{{logout_link}}", $logout_link, $text); - $text = str_replace("{{logout_url}}", $logout_url, $text); - $text = str_replace(urlencode("{{login_url}}"), $login_url, $text); - $text = str_replace(urlencode("{{login_code}}"), urlencode($sess_code), $text); - $text = str_replace(urlencode("{{settings_url}}"), $settings_url, $text); - $text = str_replace(urlencode("{{logout_url}}"), $logout_url, $text); - - return $text; -} diff --git a/application/Library/LogParser.php b/application/Library/LogParser.php deleted file mode 100644 index 28c3477a2..000000000 --- a/application/Library/LogParser.php +++ /dev/null @@ -1,101 +0,0 @@ -'; - - const LOG_MARKER_ALERTS_END = ''; - - const LOG_MARKER_START_GM = 'Processing run >>>'; - - public function __construct() { - - } - - public function getCronLogFiles() { - $search = APPLICATION_ROOT . 'tmp/logs/cron/*.log'; - $files = array(); - foreach (glob($search) as $file) { - $filename = str_replace('cron-run-', '', basename($file)); - $files[$filename] = $file; - } - return $files; - } - - public function printCronLogFile($file, $expand = false) { - $file = APPLICATION_ROOT . 'tmp/logs/cron/cron-run-' . $file; - if (!file_exists($file)) { - return null; - } - - $handle = fopen($file, "r"); - $id = 1; - $class = $expand ? ' in' : null; - $openRow = false; - if ($handle) { - while (($line = fgets($handle)) !== false) { - $line = trim($line); - if (!$line) { - continue; - } - - if (strstr($line, self::LOG_MARKER)) { - $id++; - continue; - } - - if (strstr($line, self::LOG_MARKER_START) !== false || strstr($line, self::LOG_MARKER_START_GM) !== false) { - if ($openRow === true) { - echo ''; - $id++; - } - $openRow = true; - $id_str = 'log-entry-' . $id; - $time = strtotime($this->stripLineTime($line, true)); - echo '
';
-
- echo '
';
- } elseif (strstr($line, self::LOG_MARKER_ALERTS_START) !== false) {
- echo '';
- $date = 'Cron run: ' . date('Y-m-d H:i', $time);
- echo ''.$date.'';
- echo '
';
-
- echo '';
- } elseif (strstr($line, self::LOG_MARKER_END) !== false) {
- $openRow = false;
- echo '
';
- } elseif (strstr($line, self::LOG_MARKER_ALERTS_END) !== false) {
- echo '
';
- } else {
- echo $this->stripLineTime($line);
- }
- }
-
- fclose($handle);
- } else {
- echo 'an error occured while trying to open log file';
- }
- }
-
- protected function stripLineTime($line, $returntime = false) {
- $pattern = '/(?P', '', $line)); - } - -} diff --git a/application/Library/OSF.php b/application/Library/OSF.php deleted file mode 100644 index e2fd5f512..000000000 --- a/application/Library/OSF.php +++ /dev/null @@ -1,390 +0,0 @@ - $value) { - if (property_exists($this, $property)) { - $this->{$property} = $value; - } - } - } - } - - /** - * Set access token. Array should contain @access_token and @expires entries - * - * @param array $access_token - */ - public function setAccessToken(array $access_token) { - $this->access_token = $access_token; - } - - /** - * Method to request access token, called from login() - * Extending Adapters may override this. - * - * @param array $params - * @return array - */ - protected function getAccessToken($params) { - return (array )$this->fetch($this->token_uri, $params, CURL::HTTP_METHOD_POST); - } - - /** - * Login method called from web with adapter specific parameters. - * - * After this method is called a valid session should be created that - * can be passed as parameter to profile() method. - * - * @param $params - * @param $token_params - * @return array parameters containing key => val pairs that uniquely identify the session - */ - public function login($params, array $token_params = array()) { - if (!empty($params['error'])) { - throw new OSF_Exception($params['error']); - } - - if (empty($params['code'])) { - throw new OSF_Exception("code is required"); - } - - // Set paramters tha are necessary for getting access token - if (!$token_params) { - $token_params = array( - 'client_id' => $this->client_id, - 'client_secret' => $this->client_secret, - 'grant_type' => 'authorization_code', - 'code' => $params['code'], - 'redirect_uri' => $this->getConnectUrl(), - ); - } - - // pack params urlencoded instead of array, or curl will use multipart/form-data as Content-Type - $token_params = http_build_query($token_params, null, '&'); - // TODO: To access API service after access token expired, need to get another access token with refresh token. - $result = $this->getAccessToken($token_params); - if (isset($result['expires'])) { - // convert to timestamp, as relative expire has no use later - $result['expires'] = time() + $result['expires']; - } elseif (isset($result['expires_in'])) { - // convert to timestamp, as relative expire has no use later - $result['expires'] = time() + $result['expires_in']; - } - - // save for debugging - $result['code'] = $params['code']; - - return $result; - } - - /** - * Fetch URL, decodes json response and checks for basic errors - * - * @throws OSF_Exception - * @param string $url - * @param array $params Url Parameters - * @param string $method GET or POST - * @param bool $json - * @return mixed json decoded data - */ - protected function fetch($url, $params = array(), $method = CURL::HTTP_METHOD_GET, $json = true, $curlopts = array()) { - $curlopts += $this->curlOpts(); - - $content = CURL::HttpRequest($url, $params, $method, $curlopts); - - /** @var $result mixed */ - $result = null; - if ($json) { - $result = json_decode($content); - } else { - // For Adapters that don't return a json object but a query string - parse_str($content, $result); - $result = (object)$result; - } - - if ($result === null) { - $url = CURL::urljoin($url, $params); - throw new OSF_Exception("Failed to parse response"); - } - - if (!empty($result->error)) { - if (isset($result->error->subcode)) { - throw new OSF_Exception($result->error->message, $result->error->code, $result->error->subcode, $result->error->type); - - } elseif (isset($result->error->code)) { - throw new OSF_Exception($result->error->message, $result->error->code, 0, $result->error->type); - - } elseif (isset($result->error->type)) { - throw new OSF_Exception($result->error->message, 0, 0, $result->error->type); - - } elseif (isset($result->error->description)) { - throw new OSF_Exception($result->error->description); - - } elseif (isset($result->error_description)) { - throw new OSF_Exception($result->error_description); - - } else { - throw new OSF_Exception($result->error); - } - } - - return $result; - } - - /** - * Get url where adapter should return on connecting. - * - * @return string - */ - public function getConnectUrl() { - return $this->redirect_url; - } - - /** - * URL to which user should be redirected to for login - * @return string - */ - public function getLoginUrl() { - $url = CURL::urljoin($this->authorization_uri, array( - 'client_id' => $this->client_id, - 'scope' => $this->scope, - 'response_type' => 'code', - 'redirect_uri' => $this->getConnectUrl(), - 'state' => $this->state, - 'display' => 'popup', - )); - return $url; - } - - public static function getUserAccessToken(User $user) { - $db = DB::getInstance(); - $row = $db->findRow('osf', array('user_id' => $user->id)); - if (!$row || $row['access_token_expires'] < time()) { - return false; - } - return array( - 'access_token' => $row['access_token'], - 'expires' => $row['access_token_expires'], - ); - } - - public static function setUserAccessToken(User $user, $token) { - $db = DB::getInstance(); - $db->insert_update('osf', array( - 'user_id' => $user->id, - 'access_token' => $token['access_token'], - 'access_token_expires' => $token['expires'], - ), array( - 'access_token', 'access_token_expires' - )); - } - - /** - * Upload a file under a particular OSF node - * - * @param string $node_id OSF node id - * @param string $file absolute path to file - * @param string $osf_file name of file on the OSF server - * - * @uses access_token - * @return OSF_Response - * @throws OSF_Exception - */ - public function upload($node_id, $file, $osf_file) { - if (!file_exists($file)) { - throw new OSF_Exception("Requested file not found"); - } - - $info = null; - $params = array('format' => 'json', '_'=>time()); - $url = $this->api . '/nodes/' . $node_id . '/files/'; - try { - $files_json = CURL::HttpRequest($url, $params, CURL::HTTP_METHOD_GET, $this->curlOpts(), $info); - } catch (Exception $e) { - $files_json = $this->wrapError($e->getMessage()); - } - - $response = new OSF_Response($files_json, $info); - if ($response->hasError()) { - return $response; - } - - $links = $response->getJSON()->data[0]->links; - $curlopts = $this->curlOpts(); - $curlopts[CURLOPT_POSTFIELDS] = file_get_contents($file); - $upload_url = $links->upload . '?' . http_build_query(array('kind' => 'file', 'name' => $osf_file)); - $uploaded = CURL::HttpRequest($upload_url, array('file' => CURL::getPostFileParam($file)), CURL::HTTP_METHOD_PUT, $curlopts, $info); - - return new OSF_Response($uploaded, $info); - } - - /** - * Retrieve project list of particular user - * - * @param string $user OSF id of that user. Defaults to 'me' for authenticated user - * @return OSF_Response - * @throws OSF_Exception - */ - public function getProjects($user = 'me') { - $params = array('format' => 'json'); - $info = null; - - try { - // first get user information to obtain nodes_api for that user - $url = $this->api . '/users/' . $user; - $json = CURL::HttpRequest($url, $params, CURL::HTTP_METHOD_GET, $this->curlOpts(), $info); - $userResponse = new OSF_Response($json, $info); - if ($userResponse->hasError()) { - return $userResponse; - } - $nodesApi = $userResponse->getJSON()->data->links->self . 'nodes/'; - - // get project list from user's nodes - $params['filter'] = array('category' => 'project'); - $json = CURL::HttpRequest($nodesApi, $params, CURL::HTTP_METHOD_GET, $this->curlOpts(), $info); - } catch (Exception $e) { - $json = $this->wrapError($e->getMessage()); - } - - return new OSF_Response($json, $info); - } - - protected function curlOpts() { - $curlopts = array(); - - if (!$this->is_https) { - $curlopts[CURLOPT_SSL_VERIFYHOST] = 0; - $curlopts[CURLOPT_SSL_VERIFYPEER] = 0; - } - - if ($this->access_token) { - $curlopts[CURLOPT_HTTPHEADER] = array("Authorization: Bearer {$this->access_token['access_token']}"); - } - return $curlopts; - } - - private function wrapError($error) { - return json_encode(array('errors' => array(array('detail' => $error)))); - } -} - -class OSF_Response { - - protected $json; - - protected $json_string; - - protected $http_info = array(); - - public function __construct($string, array $http_info = array()) { - $this->json_string = $string; - $this->json = @json_decode($string); - $this->http_info = $http_info; - } - - public function hasError() { - if (!empty($this->json->errors)) { - return true; - } - return isset($this->http_info['http_code']) && ($this->http_info['http_code'] < 200 || $this->http_info['http_code'] > 302); - } - - public function getError() { - if (!empty($this->json->errors)) { - $err = array(); - foreach ($this->json->errors as $error) { - $err[] = $error->detail; - } - return implode(".\n ", $err); - } - return isset($this->json->message) ? $this->json->message : null; - } - - public function getErrorCode() { - return isset($this->json->code) ? $this->json->code : null; - } - - public function getJSON() { - return $this->json; - } - - public function getJSONString() { - $this->json_string; - } - - public function getHttpInfo() { - return $this->http_info; - } -} - -class OSF_Exception extends Exception {} - diff --git a/application/Library/OpenCPU.php b/application/Library/OpenCPU.php deleted file mode 100644 index 27b48f2f3..000000000 --- a/application/Library/OpenCPU.php +++ /dev/null @@ -1,523 +0,0 @@ -==========formr=opencpu=string=delimiter=========="; - - /** - * @var OpenCPU[] - */ - protected static $instances = array(); - /** - * @var OpenCPU_Session[] - */ - protected $cache = array(); - - /** - * Additional curl options to set when making curl request - * - * @var Array - */ - private $curl_opts = array( - CURLINFO_HEADER_OUT => true, - CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4, - CURLOPT_HEADER => true, - CURLOPT_ENCODING => "" - ); - - private $curl_info = array(); - - /** - * @var OpenCPU_Request - */ - protected $request; - - /** - * Get an instance of OpenCPU class - * - * @param string $instance Config item name that holds opencpu base URL - * @return OpenCPU - */ - public static function getInstance($instance = 'opencpu_instance') { - if (!isset(self::$instances[$instance])) { - self::$instances[$instance] = new self($instance); - } - return self::$instances[$instance]; - } - - protected function __construct($instance) { - $config = (array) Config::get($instance); - foreach ($config as $key => $value) { - $property = lcfirst(preg_replace('/\s+/', '', ucwords(str_replace('_', ' ', $key)))); - if (property_exists($this, $property)) { - $this->{$property} = $value; - } - } - } - - /** - * @param string $baseUrl - */ - public function setBaseUrl($baseUrl) { - if ($baseUrl) { - $baseUrl = rtrim($baseUrl, "/"); - $this->baseUrl = $baseUrl; - } - } - - public function getBaseUrl() { - return $this->baseUrl; - } - - public function getRLibPath() { - return $this->rLibPath; - } - public function getRTempBaseUrl() { - return self::TEMP_BASE_URL; - } - - public function setLibUrl($libUri) { - $libUri = trim($libUri, "/"); - $this->libUri = '/' . $libUri; - } - - public function getLibUri() { - return $this->libUri; - } - - public function getLastMessage() { - return $this->last_message; - } - - /** - * @return OpenCPU_Request - */ - public function getRequest() { - return $this->request; - } - - /** - * Get Response headers of opencpu request - * - * @return null|array - */ - public function getResponseHeaders() { - if (isset($this->curl_info[CURL::RESPONSE_HEADERS])) { - return $this->curl_info[CURL::RESPONSE_HEADERS]; - } elseif(isset($this->curl_info['raw_header'])) { - return http_parse_headers($this->curl_info['raw_header']); - } - return null; - } - - public function getRequestInfo($item = null) { - if ($item && isset($this->curl_info[$item])) { - return $this->curl_info[$item]; - } elseif ($item) { - return null; - } - return $this->curl_info; - } - - private function call($uri = '', $params = array(), $method = CURL::HTTP_METHOD_GET) { - $cachekey = md5(serialize(func_get_args())); - if (isset($this->cache[$cachekey])) { - return $this->cache[$cachekey]; - } - - - if ($uri && strstr($uri, $this->baseUrl) === false) { - $uri = "/" . ltrim($uri, "/"); - $url = $this->baseUrl . $this->libUri . $uri; - } else { - $url = $uri; - } - - // set global props - $this->curl_info = array(); - $this->request = new OpenCPU_Request($url, $method, $params); - - $curl_opts = $this->curl_opts; - // encode request - if ($method === CURL::HTTP_METHOD_POST) { - $params = array_map(array($this, 'cr2nl'), $params); - $params = http_build_query($params); - $curl_opts = $this->curl_opts + array(CURLOPT_HTTPHEADER => array( - 'Content-Length: ' . strlen($params), - )); - } - - // Maybe something bad happen in CURL request just throw it with OpenCPU_Exception with message returned from CURL - try { - $results = CURL::HttpRequest($url, $params, $method, $curl_opts, $this->curl_info); - } catch (Exception $e) { - throw new OpenCPU_Exception($e->getMessage(), -1, $e); - } - - if ($this->curl_info['http_code'] == 400) { - $results = "R Error: $results"; - return new OpenCPU_Session(null, null, $results, $this); - } elseif ($this->curl_info['http_code'] < 200 || $this->curl_info['http_code'] > 302) { - if (!$results) { - $results = "OpenCPU server '{$this->baseUrl}' could not be contacted"; - } - throw new OpenCPU_Exception($results, $this->curl_info['http_code']); - } - - $headers = $this->getResponseHeaders(); - if ($method === CURL::HTTP_METHOD_GET) { - $headers['Location'] = $url; - if(preg_match("@/(x0[a-z0-9-_~]+)/@",$url, $matches)): - $headers['X-Ocpu-Session'] = $matches[1]; - endif; - } - if (!$headers || empty($headers['Location']) || empty($headers['X-Ocpu-Session'])) { - $request = sprintf('[uri %s] %s', $uri, print_r($params, 1)); - throw new OpenCPU_Exception("Response headers not gotten from request $request"); - } - - $this->cache[$cachekey] = new OpenCPU_Session($headers['Location'], $headers['X-Ocpu-Session'], $results, $this); - return $this->cache[$cachekey]; - } - - /** - * Send a POST request to OpenCPU - * - * @param string $uri A uri that is relative to openCPU's library entry point for example '/markdown/R/render' - * @param array $params An array of parameters to pass - * @throws OpenCPU_Exception - * @return OpenCPU_Session - */ - public function post($uri = '', $params = array()) { - return $this->call($uri, $params, CURL::HTTP_METHOD_POST); - } - - /** - * Send a GET request to OpenCPU - * - * @param string $uri A uri that is relative to openCPU's library entry point for example '/markdown/R/render' - * @param array $params An array of parameters to pass - * @throws OpenCPU_Exception - * @return OpenCPU_Session - */ - public function get($uri = '', $params = array()) { - return $this->call($uri, $params, CURL::HTTP_METHOD_GET); - } - - /** - * Execute a snippet of R code - * - * @param string $code - * @return OpenCPU_Session - */ - public function snippet($code) { - $params = array('x' => '{ -(function() { - ' . $code . ' -})()}'); - return $this->post('/base/R/identity', $params); - } - - private function cr2nl($string) { - return str_replace("\r\n", "\n", $string); - } - -} - -class OpenCPU_Session { - - /** - * @var string - */ - protected $raw_result; - - /** - * @var string - */ - protected $key; - - /** - * @var string - */ - protected $location; - - /** - * @var OpenCPU - */ - private $ocpu; - - /** - * @var integer - */ - private $object_length = null; - - public function __construct($location, $key, $raw_result, OpenCPU $ocpu = null) { - $this->raw_result = $raw_result; - $this->key = $key; - $this->location = $location; - $this->ocpu = $ocpu; - } - - /** - * Returns the list of returned paths as a string separated by newline char - * - * @return string - */ - public function getRawResult() { - return $this->raw_result; - } - - /** - * @return OpenCPU_Request - */ - public function getRequest() { - return $this->ocpu->getRequest(); - } - - public function isJSONResult() { - return ($this->ocpu->getRequestInfo("content_type") === "application/json"); - } - - /** - * Returns the list of returned paths as a string separated by newline char - * - * @param bool $as_array If TRUE, paths will be returned in an array - * @return string|array - */ - public function getResponse($as_array = false) { - if ($as_array === true) { - return explode("\n", $this->raw_result); - } - return $this->raw_result; - } - - public function getKey() { - return $this->key; - } - - /** - * Get an array of files present in current session - * - * @param string $match You can match only files with some slug in the path name - * @return array - */ - public function getFiles($match = '/files/') { - if (!$this->key) { - return null; - } - - $files = array(); - $result = explode("\n", $this->raw_result); - foreach ($result as $path) { - if (!$path || strpos($path, $match) === false) { - continue; - } - - $id = basename($path); - $files[$id] = $this->getResponsePath($path); - } - return $files; - } - - /** - * Get absolute URLs of all resources in the response - * - * @return array - */ - public function getResponsePaths() { - if (!$this->key || $this->isJSONResult()) { - return null; - } - - $result = explode("\n", $this->raw_result); - $files = array(); - foreach ($result as $id => $path) { - $files[$id] = $this->getResponsePath($path); - } - return $files; - } - public function getResponsePathsAsLinks() { - if (!$this->key || $this->isJSONResult()) { - return null; - } - - $result = explode("\n", $this->raw_result); - $files = array(); - foreach ($result as $path) { - $files[$path] = $this->getResponsePath($path); - } - return $files; - } - - public function getLocation() { - return $this->location; - } - - public function getFileURL($path) { - return $this->getResponsePath('/files/' . $path); - } - - public function getObject($name = 'json', $params = array()) { - if (!$this->key) { - return null; - } - - $url = $this->getLocation() . 'R/.val/' . $name; - $info = array(); // just in case needed in the furture to get curl info - $object = CURL::HttpRequest($url, $params, $method = CURL::HTTP_METHOD_GET, array(), $info); - if ($name === 'json') { - $object = $this->getJSONObject($object); - } - if(is_string($object)) { - $object = str_replace($this->ocpu->getRLibPath(), $this->getBaseUrl() . $this->ocpu->getLibUri(), $object); - return str_replace($this->ocpu->getRTempBaseUrl() , $this->getLocation().'files/', $object); - } - - return $object; - } - - public function getJSONObject($string = null, $as_assoc = true) { - if (!$this->key) { - return null; - } - - if ($string === null) { - $string = $this->raw_result; - } - $json = json_decode($string, $as_assoc); - $this->object_length = count($json); - // if decoded object is a non-empty array, get it's first element - if (is_array($json) && array_key_exists(0, $json)) { - if(is_string($json[0])) { - $string = str_replace($this->ocpu->getRLibPath(), $this->getBaseUrl() . $this->ocpu->getLibUri(), $json[0]); - return str_replace($this->ocpu->getRTempBaseUrl() , $this->getLocation().'files/', $string); - } - return $json[0]; - } - - return $json; - } - - public function getObjectLength() { - return $this->object_length; - } - - public function getStdout() { - if (!$this->key) { - return null; - } - - $url = $this->getLocation() . 'stdout'; - $info = array(); // just in case needed in the furture to get curl info - return CURL::HttpRequest($url, null, $method = CURL::HTTP_METHOD_GET, array(), $info); - } - - public function getConsole() { - if (!$this->key) { - return null; - } - - $url = $this->getLocation() . 'console'; - $info = array(); // just in case needed in the furture to get curl info - return CURL::HttpRequest($url, null, $method = CURL::HTTP_METHOD_GET, array(), $info); - } - - public function getInfo() { - if (!$this->key) { - return null; - } - - $url = $this->getLocation() . 'info'; - $info = array(); // just in case needed in the furture to get curl info - return CURL::HttpRequest($url, null, $method = CURL::HTTP_METHOD_GET, array(), $info); - } - - public function hasError() { - return $this->ocpu->getRequestInfo('http_code') >= 400; - } - - public function getError() { - if (!$this->hasError()) { - return null; - } - return $this->raw_result; - } - - /** - * @return OpenCPU - */ - public function caller() { - return $this->ocpu; - } - - public function getResponseHeaders() { - return $this->caller()->getResponseHeaders(); - } - - public function getBaseUrl() { - return $this->caller()->getBaseUrl(); - } - - protected function getResponsePath($path) { - return $this->caller()->getBaseUrl() . $path; - } -} - -class OpenCPU_Request { - - protected $url; - - protected $params; - - protected $method; - - public function __construct($url, $method, $params = null) { - $this->url = $url; - $this->method = $method; - $this->params = $params; - } - - public function getUrl() { - return $this->url; - } - - public function getMethod() { - return $this->method; - } - - public function getParams() { - return $this->params; - } - - public function __toString() { - $request = array("METHOD: {$this->method}", "URL: {$this->url}", "PARAMS: " . $this->stringify($this->params)); - return implode("\n", $request); - } - - protected function stringify($object) { - if (is_string($object)) { - return $object; - } - - $string = "\n"; - if (is_array($object)) { - foreach ($object as $key => $value) { - $value = $this->stringify($value); - $string .= "{$key} = {$value} \n"; - } - } else { - $string .= (string) $object; - } - - return $string; - } -} - -class OpenCPU_Exception extends Exception {} diff --git a/application/Library/Request.php b/application/Library/Request.php deleted file mode 100644 index a79d06781..000000000 --- a/application/Library/Request.php +++ /dev/null @@ -1,213 +0,0 @@ - $value) { - $this->__set($key, $value); - } - } - } - - /** - * @param string $name - */ - public function __isset($name) { - return isset($this->data[$name]); - } - - /** - * @param string $name - * @param mixed $value - */ - public function __set($name, $value) { - $this->data[$name] = self::stripslashes(self::stripControlChars($value)); - } - - /** - * @param string $name - * @return mixed - */ - public function __get($name) { - if ($this->__isset($name)) { - return $this->data[$name]; - } - - return null; - } - - /** - * Get all parameters from $_REQUEST variable - * - * @return array - */ - public function getParams() { - return $this->data; - } - - /** - * Get parameter - * - * @param string $name - * @return mixed - */ - public function getParam($name, $default = null) { - $param = $this->__get($name); - if ($param === null) { - $param = $default; - } - return $param; - } - - /** - * Recursively input clean control characters (low bits in ASCII table) - * - * @param array|mixed|string $value - * @return array|mixed|string - */ - public function stripControlChars($value) { - if (is_array($value)) { - foreach ($value as $key => $val) { - $value[$key] = self::stripControlChars($val); - } - } else { - // strip control chars, backspace and delete (including \r) - $value = preg_replace('/[\x00-\x08\x0b-\x1f\x7f]/', '', $value); - } - - return $value; - } - - /** - * Access a request parameter as int - * - * @param string $name Parameter name - * @param mixed $default Default to return if parameter isn't set or is an array - * @param bool $nonempty Return $default if parameter is set but empty() - * @return int - */ - public function int($name, $default = 0, $nonempty = false) { - if (!isset($this->data[$name])) return $default; - if (is_array($this->data[$name])) return $default; - if ($this->data[$name] === '') return $default; - if ($nonempty && empty($this->data[$name])) return $default; - - return (int)$this->data[$name]; - } - - /** - * Access a request parameter as string - * - * @param string $name Parameter name - * @param mixed $default Default to return if parameter isn't set or is an array - * @param bool $nonempty Return $default if parameter is set but empty() - * @return string - */ - public function str($name, $default = '', $nonempty = false) { - if (!isset($this->data[$name])) return $default; - if (is_array($this->data[$name])) return $default; - if ($nonempty && empty($this->data[$name])) return $default; - - return (string)$this->data[$name]; - } - - /** - * Access a request parameter as bool - * - * Note: $nonempty is here for interface consistency and makes not much sense for booleans - * - * @param string $name Parameter name - * @param mixed $default Default to return if parameter isn't set - * @param bool $nonempty Return $default if parameter is set but empty() - * @return bool - */ - public function bool($name, $default = false, $nonempty = false) { - if (!isset($this->data[$name])) return $default; - if (is_array($this->data[$name])) return $default; - if ($this->data[$name] === '') return $default; - if ($nonempty && empty($this->data[$name])) return $default; - - return (bool)$this->data[$name]; - } - - /** - * Access a request parameter as array - * - * @param string $name Parameter name - * @param mixed $default Default to return if parameter isn't set - * @param bool $nonempty Return $default if parameter is set but empty() - * @return array - */ - public function arr($name, $default = array(), $nonempty = false) { - if (!isset($this->data[$name])) return $default; - if (!is_array($this->data[$name])) return $default; - if ($nonempty && empty($this->data[$name])) return $default; - - return (array)$this->data[$name]; - } - - /** - * Access a request parameter as float - * - * @param string $name Parameter name - * @param mixed $default Default to return if parameter isn't set or is an array - * @param bool $nonempty Return $default if parameter is set but empty() - * @return float - */ - public function float($name, $default = 0, $nonempty = false) { - if (!isset($this->data[$name])) return $default; - if (is_array($this->data[$name])) return $default; - if ($this->data[$name] === '') return $default; - if ($nonempty && empty($this->data[$name])) return $default; - - return (float)$this->data[$name]; - } - - public static function isHTTPPostRequest() { - return strtolower($_SERVER['REQUEST_METHOD']) === 'post'; - } - - public static function isHTTPGetRequest() { - return strtolower($_SERVER['REQUEST_METHOD']) === 'get'; - } - - public static function isAjaxRequest() { - return strtolower(env('HTTP_X_REQUESTED_WITH')) === 'xmlhttprequest'; - } - - public static function setGlobals($key, $value) { - self::$globals[$key] = $value; - } - - public static function getGlobals($key, $default = null) { - return isset(self::$globals[$key]) ? self::$globals[$key] : $default; - } - - private static function stripslashes($value) { - // skip objects (object.toString() results in wrong output) - if (!is_object($value) && !is_array($value)) { - if (get_magic_quotes_gpc() == 1) { - $value = stripslashes($value); - } - // object is array - } elseif (is_array($value)) { - foreach ($value as $k => $v) { - $value[$k] = self::stripslashes($v); - } - } - - return $value; - } -} diff --git a/application/Library/Response.php b/application/Library/Response.php deleted file mode 100644 index dd1cf325b..000000000 --- a/application/Library/Response.php +++ /dev/null @@ -1,278 +0,0 @@ -config = $config; - } - - /** - * Sets the response status code. - * - * @param integer $code HTTP status code - * @param mixed $text HTTP status text - * @return Response - */ - public function setStatusCode($code, $text = null) { - $code = (int) $code; - $text = $text ? $text : "Status $code"; - // status - header(sprintf('HTTP/1.0 %s %s', $code, $text)); - - return $this; - } - - /** - * Resource not found - * @return void - */ - public function notFound() { - $this->setStatusCode(self::STATUS_NOT_FOUND, 'Resource Not Found'); - $this->setHeader('Pragma', 'no-cache'); - exit; - } - - /** - * Bad request: may be cached, it won't improve if fetched again - * - * @param $message string - * @return void - */ - public function badRequest($message = "") { - $this->setStatusCode(self::STATUS_BAD_REQUEST, 'Bad Request'); - if ($message) { - echo "
{$message}
"; - } - exit; - } - - /** - * Not modified: the request was verified to be identical with previous cache - * - * @param $etag - * @return void - */ - public function notModified($etag) { - // if not modified, save some cpu and bandwidth - $this->setStatusCode(self::STATUS_NOT_MODIFIED, 'Not Modified'); - $this->setEtag($etag); - exit; - } - - /** - * Forbidden, access to this resource is not allowed - * - * @return void - */ - public function forbidden() { - $this->setStatusCode(self::STATUS_FORBIDDEN, 'Forbidden'); - exit; - } - - /** - * Internal/Fatal Error - * - * @return void - */ - public function fatalError() { - $this->setStatusCode(self::STATUS_INTERNAL_SERVER_ERROR, 'Internal Error'); - exit; - } - - /** - * Gateway timeout - * - * @return void - */ - public function gatewayTimeout() { - $this->setStatusCode(self::STATUS_GATEWAY_TIMEOUT, 'Gateway Timeout'); - exit; - } - - public function badMethod($message = '') { - $this->setStatusCode(self::STATUS_METHOD_NOT_ALLOWED, 'Method Not Allowed'); - if ($message) { - echo "{$message}
"; - } - exit; - } - - /** - * Set Content-Type HTTP header - * - * @param string $content_type - * @return Response - */ - public function setContentType($content_type) { - $this->contentType = $content_type; - return $this->setHeader('Content-Type', $content_type); - } - - /** - * Get Content-Type HTTP header - * - * @return string - * @since 1.3 - */ - public function getContentType() { - return $this->contentType; - } - - /** - * Set Content-Length HTTP header - * - * @param int $length - * @return Response - */ - public function setContentLength($length) { - return $this->setHeader('Content-Length', $length); - } - - /** - * Sets the response content. - * - * Valid types are strings, numbers, and objects that implement a __toString() method. - * - * @param mixed $content - * @return Response - * @throws UnexpectedValueException - */ - public function setContent($content) { - if (null !== $content && !is_string($content) && !is_numeric($content) && !is_callable(array($content, '__toString'))) { - throw new UnexpectedValueException('The Response content must be a string or object implementing __toString(), "' . gettype($content) . '" given.'); - } - - $this->content = (string) $content; - - return $this; - } - - /** - * Set JSON response content - * - * @param mixed $content Can be of any type except a resource. - * @return Response - * @throws UnexpectedValueException - */ - public function setJsonContent($content) { - if (is_string($content)) { - return $this->setContent($content); - } - - if (!$content = json_encode($content)) { - throw new UnexpectedValueException('The Response content cannot be json encoded'); - } - - return $this->setContent($content); - } - - /** - * Gets the current response content. - * - * @return string Content - */ - public function getContent() { - return $this->content; - } - - /** - * Sets the ETag value. - * - * @param string $etag The ETag unique identifier - * @return Response - */ - public function setEtag($etag) { - return $this->setHeader('Etag', '"' . $etag . '"'); - } - - /** - * Set HTTP Response header. - * - * @param string $header - * @param string $value - * @param bool $replace - * @return Response - */ - public function setHeader($header, $value, $replace = true) { - header("$header: $value", $replace); - - return $this; - } - - /** - * Marks the response as "private". - * It makes the response ineligible for serving other clients. - * - * @return Response - */ - public function setPrivate() { - return $this->setHeader('Cache-Control', 'private'); - } - - /** - * Send caching header - * - * @param string $duration Any string supported my PHP's strtotime() function (http://php.net/manual/en/function.strtotime.php) - * @param bool $public - * @return Response - */ - public function setCacheHeaders($duration, $public = true) { - $time = strtotime($duration); - if (!$time) { - return $this; - } - - $max_age = $time - time(); - $cache = $public ? 'public' : 'private'; - return $this->setHeader('Cache-Control', $cache . ', max-age=' . $max_age); - } - - /** - * Send out Response content. - * Note that this ends the request - * - * @return void - */ - public function send() { - if ($this->content) { - echo $this->content; - } - exit; - } - -} diff --git a/application/Library/Router.php b/application/Library/Router.php deleted file mode 100644 index ffd7a688c..000000000 --- a/application/Library/Router.php +++ /dev/null @@ -1,206 +0,0 @@ -site = $site; - $this->routes = Config::get('routes'); - $this->usingSubDomain = Config::get('use_study_subdomains'); - $this->serverName = isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : null; - if (!$this->serverName) { - throw new Exception('Server name not explicitly defined'); - } - } - - /** - * @return Router - */ - public function route() { - $route = $this->site->request->str('route'); - $routeSlugs = $this->extractRouteSlugs($route); - $params = null; - - // First try to get controller path from the route which is one of those configured routes - foreach ($routeSlugs as $slug) { - if (isset($this->routes[$slug])) { - $controller = $this->routes[$slug]; - $params = $this->getParamsFromRoute($route, $slug); - break; - } - } - - if (empty($controller)) { - $controller = $this->getControllerName('public'); - } - - if ($params === null) { - $params = $this->getParamsFromRoute($route, ''); - } - - $action = array_shift($params); - if (!$action) { - $action = 'index'; - } - - // Check if action exists in controller and if it doesn't assume we are looking at a run - // @todo validate runs not to have controller action names (especially PublicController) - $controllerName = $controller; - $actionName = $this->getActionName($action); - if (!class_exists($controllerName, true)) { - throw new Exception ("Controller $controllerName does not exist"); - } - - // Sub-domains for now are used only for accessing studies - if ($this->usingSubDomain && FMRSD_CONTEXT) { - list($controllerName, $actionName) = $this->getStudyRoute(); - $runName = $this->getRunFromSubDomain(); - if ($action !== 'index') { - array_unshift($params, $action); - } - array_unshift($params, $runName); - } - - if (!method_exists($controllerName, $actionName)) { - // Assume at this point user is trying to access a private action via the indexAction - list($controllerName, $actionName) = $this->shiftAction($controllerName); - // push back the $action as an action parameter - array_unshift($params, $action); - } - - $this->controller = $controllerName; - $this->action = $actionName; - $this->params = $params; - $this->site->setPath($route); - return $this; - } - - private function getControllerName($controllerPath) { - $parts = array_filter(explode('/', $controllerPath)); - $parts = array_map('ucwords', array_map('strtolower', $parts)); - return implode('', $parts) . 'Controller'; - } - - private function getActionName($action) { - if (strpos($action, '-') !== false) { - $parts = array_filter(explode('-', $action)); - } else { - $parts = array_filter(explode('_', $action)); - } - $action = array_shift($parts); - foreach ($parts as $part) { - $action .= ucwords(strtolower($part)); - } - return $action . 'Action'; - } - - /** - * Some hack method to shift blame when we can't find action in controller - * - * @param string $controller - * @return string - */ - private function shiftAction($controller) { - if ($controller === 'PublicController') { - return $this->getStudyRoute(); - } - return array($controller, 'indexAction'); - } - - /** - * Some hack method to shift blame when we can't find action in controller - * - * @return array - */ - private function getStudyRoute() { - return array('RunController', 'indexAction'); - } - - /** - * Get Run name from sub-domain - * - * @return string - */ - private function getRunFromSubDomain() { - $host = explode('.', $this->serverName); - $subdomains = array_slice($host, 0, count($host) - 2); - return $subdomains[0]; - } - - private function extractRouteSlugs($route) { - $parts = explode('/', $route); - $slugs = array(); - $prev = ''; - foreach ($parts as $r) { - $slug = trim(implode('/', array($prev, $r)), '\/'); - $slugs[] = $slug; - $prev = $slug; - } - - return array_reverse($slugs); - } - - private function getParamsFromRoute($route, $base) { - $route = '/' . trim($route, "\\\/") . '/'; - $base = '/' . trim($base, "\\\/") . '/'; - $params = (array)array_filter(explode('/', str_replace($base, '', $route))); - - return $params; - } - - public function execute() { - $controller_ = $this->controller; - $action = $this->action; - - $controller = new $controller_($this->site); - if (!method_exists($controller, $action)) { - throw new Exception("Action $action not found in $controller_"); - } - - return call_user_func_array(array($controller, $action), $this->params); - } - - /** - * @return Router - */ - public static function getInstance() { - if (self::$instance === null) { - global $site; - self::$instance = new self($site); - } - return self::$instance; - } - - public static function getWebRoot() { - return Config::get('web_dir'); - } - - public static function isWebRootDir($name) { - return is_dir(self::getWebRoot() . '/' . $name); - } -} - diff --git a/application/Library/Session.php b/application/Library/Session.php deleted file mode 100644 index a88d53395..000000000 --- a/application/Library/Session.php +++ /dev/null @@ -1,106 +0,0 @@ - $value) { - self::$key = $value; - } - } - - /** - * Start a PHP session - */ - public static function start() { - session_name(self::$name); - session_set_cookie_params(self::$lifetime, self::$path, self::$domain, self::$secure, self::$httponly); - session_start(); - } - - public static function destroy() { - setcookie(session_name(), '', time() - 3600); - session_unset(); - session_destroy(); - } - - public static function over() { - static $closed; - if ($closed) { - return false; - } - session_write_close(); - $closed = true; - return true; - } - - public static function isExpired($expiry) { - return isset($_SESSION['last_activity']) && (time() - $_SESSION['last_activity'] > $expiry); - } - - public static function set($key, $value) { - $_SESSION[$key] = $value; - } - - public static function get($key, $default = null) { - return isset($_SESSION[$key]) ? $_SESSION[$key] : $default; - } - - public static function delete($key) { - if (isset($_SESSION[$key])) { - unset($_SESSION[$key]); - } - } - - public static function globalRefresh() { - global $user, $site; - self::set('user', serialize($user)); - self::set('site', $site); - } - - public static function getRequestToken() { - $token = sha1(mt_rand()); - if (!$tokens = self::get(self::REQUEST_TOKENS)) { - $tokens = array($token => 1); - } else { - $tokens[$token] = 1; - } - self::set(self::REQUEST_TOKENS, $tokens); - return $token; - } - - public static function canValidateRequestToken(Request $request) { - $token = $request->getParam(self::REQUEST_TOKENS); - $tokens = self::get(self::REQUEST_TOKENS, array()); - if (!empty($tokens[$token])) { - // a valid request token dies after it's validity is retrived :P - unset($tokens[$token]); - self::set(self::REQUEST_TOKENS, $tokens); - return true; - } - return false; - } -} - - diff --git a/application/Library/Template.php b/application/Library/Template.php deleted file mode 100644 index 638501186..000000000 --- a/application/Library/Template.php +++ /dev/null @@ -1,67 +0,0 @@ -'; + const LOG_MARKER_ALERTS_END = ''; + const LOG_MARKER_START_GM = 'Processing run >>>'; + const LOG_COMMENT = '....'; + + public function __construct() { + + } + + public function getCronLogFiles() { + $search = APPLICATION_ROOT . 'tmp/logs/cron/*.log'; + $files = array(); + foreach (glob($search) as $file) { + $filename = str_replace('cron-run-', '', basename($file)); + $files[$filename] = $file; + } + return $files; + } + + public function printCronLogFile($file, $expand = false) { + $file = APPLICATION_ROOT . 'tmp/logs/cron/cron-run-' . $file; + if (!file_exists($file)) { + return null; + } + + $handle = fopen($file, "r"); + $id = 1; + $class = $expand ? ' in' : null; + $openRow = false; + if ($handle) { + while (($line = fgets($handle)) !== false) { + $line = trim($line); + if (!$line || strstr($line, self::LOG_COMMENT)) { + continue; + } + + if (strstr($line, self::LOG_MARKER)) { + $id++; + continue; + } + + if (strstr($line, self::LOG_MARKER_START) !== false || strstr($line, self::LOG_MARKER_START_GM) !== false) { + if ($openRow === true) { + echo ''; + $id++; + } + $openRow = true; + $id_str = 'log-entry-' . $id; + $time = strtotime($this->stripLineTime($line, true)); + echo '';
+
+ echo '
';
+ } elseif (strstr($line, self::LOG_MARKER_ALERTS_START) !== false) {
+ echo '';
+ $date = 'Cron run: ' . date('Y-m-d H:i', $time);
+ echo '' . $date . '';
+ echo '
';
+
+ echo '';
+ } elseif (strstr($line, self::LOG_MARKER_END) !== false) {
+ $openRow = false;
+ echo '
';
+ } elseif (strstr($line, self::LOG_MARKER_ALERTS_END) !== false) {
+ echo '
';
+ } else {
+ echo $this->stripLineTime($line);
+ }
+ }
+
+ fclose($handle);
+ } else {
+ echo 'an error occured while trying to open log file';
+ }
+ }
+
+ protected function stripLineTime($line, $returntime = false) {
+ $pattern = '/(?P', '', $line)); + } + +} diff --git a/application/Model/Branch.php b/application/Model/Branch.php deleted file mode 100644 index c4254e8ce..000000000 --- a/application/Model/Branch.php +++ /dev/null @@ -1,163 +0,0 @@ -id): - $vars = $this->dbh->select('id, condition, if_true, automatically_jump, automatically_go_on') - ->from('survey_branches') - ->where(array('id' => $this->id)) - ->fetch(); - if ($vars): - array_walk($vars, "emptyNull"); - $this->condition = $vars['condition']; - $this->if_true = $vars['if_true']; - $this->automatically_jump = $vars['automatically_jump']; - $this->automatically_go_on = $vars['automatically_go_on']; - $this->valid = true; - endif; - endif; - } - - public function create($options) { - $this->dbh->beginTransaction(); - if (!$this->id) { - $this->id = parent::create($this->type); - } else { - $this->modify($options); - } - - if (isset($options['condition'])) { - array_walk($options, "emptyNull"); - $this->condition = $options['condition']; - if (isset($options['if_true'])) { - $this->if_true = $options['if_true']; - } - if (isset($options['automatically_jump'])) { - $this->automatically_jump = $options['automatically_jump']; - } - if (isset($options['automatically_go_on'])) { - $this->automatically_go_on = $options['automatically_go_on']; - } - } - $this->condition = cr2nl($this->condition); - - $this->dbh->insert_update('survey_branches', array( - 'id' => $this->id, - 'condition' => $this->condition, - 'if_true' => $this->if_true, - 'automatically_jump' => $this->automatically_jump, - 'automatically_go_on' => $this->automatically_go_on - )); - $this->dbh->commit(); - $this->valid = true; - - return true; - } - - public function displayForRun($prepend = '') { - $dialog = '
-
- -
- else - - go on -
';
- $dialog .= '
- ';
-
- $dialog = $prepend . $dialog;
-
- return parent::runDialog($dialog);
- }
-
- public function removeFromRun($special = null) {
- return $this->delete($special);
- }
-
- public function test() {
- $results = $this->getSampleSessions();
-
- if (!$results) {
- return false;
- }
-
- $this->run_session_id = current($results)['id'];
- $opencpu_vars = $this->getUserDataInRun($this->condition);
- $ocpu_session = opencpu_evaluate($this->condition, $opencpu_vars, 'text', null, true);
- echo opencpu_debug($ocpu_session, null, 'text');
-
- echo '- -
- else - - go on -
| Code (Position) | -Test | -
|---|---|
| " . $row['session'] . " ({$row['position']}) | -" . stringBool($eval) . " | -
- "; - $dialog .= '
'; - else: - $dialog = "No email accounts. Add some here.
"; - endif; - $dialog .= '- -
-- -
-
-
{{login_link}} will be replaced by a personalised link to this run, {{login_code}} will be replaced with this user\'s session code.';
-// ';
-
- $dialog .= '';
- $dialog .= '';
-
- $dialog = $prepend . $dialog;
- return parent::runDialog($dialog, 'fa-envelope');
- }
-
- public function getRecipientField($return_format = 'json', $return_session = false) {
- if (empty($this->recipient_field) || $this->recipient_field === $this->mostrecent) {
- $recent_email_query = "
- SELECT survey_items_display.answer AS email FROM survey_unit_sessions
- LEFT JOIN survey_units ON survey_units.id = survey_unit_sessions.unit_id AND survey_units.type = 'Survey'
- LEFT JOIN survey_run_units ON survey_run_units.unit_id = survey_units.id
- LEFT JOIN survey_items_display ON survey_items_display.session_id = survey_unit_sessions.id
- LEFT JOIN survey_items ON survey_items.id = survey_items_display.item_id
- WHERE
- survey_unit_sessions.run_session_id = :run_session_id AND
- survey_run_units.run_id = :run_id AND
- survey_items.type = 'email'
- ORDER BY survey_items_display.answered DESC
- LIMIT 1
- ";
-
- $get_recip = $this->dbh->prepare($recent_email_query);
- $get_recip->bindValue(':run_id', $this->run_id);
- $get_recip->bindValue(':run_session_id', $this->run_session_id);
- $get_recip->execute();
-
- $res = $get_recip->fetch(PDO::FETCH_ASSOC);
- $recipient = array_val($res, 'email', null);
- } else {
- $opencpu_vars = $this->getUserDataInRun($this->recipient_field);
- $recipient = opencpu_evaluate($this->recipient_field, $opencpu_vars, $return_format, null, $return_session);
- }
-
- return $recipient;
- }
-
- public function sendMail($who = NULL) {
- $this->mail_sent = false;
-
- if ($who === null):
- $this->recipient = $this->getRecipientField();
- else:
- $this->recipient = $who;
- endif;
-
- if ($this->recipient == null):
- //formr_log("Email recipient could not be determined from this field definition " . $this->recipient_field);
- alert("We could not find an email recipient. Session: {$this->session}", 'alert-danger');
- return false;
- endif;
-
- if ($this->account_id === null):
- alert("The study administrator (you?) did not set up an email account. Do it now and then select the account in the email dropdown.", 'alert-danger');
- return false;
- endif;
-
- $run_session = $this->run_session;
-
- $testing = !$run_session || $run_session->isTesting();
-
- $acc = new EmailAccount($this->dbh, $this->account_id, null);
- $mailing_themselves = (is_array($acc->account) && $acc->account["from"] === $this->recipient) ||
- (Site::getCurrentUser()->email === $this->recipient) ||
- ($this->run && $this->run->getOwner()->email === $this->recipient);
-
- $mails_sent = $this->numberOfEmailsSent();
- $error = null;
- $warning = null;
- if(!$mailing_themselves):
- if ($mails_sent['in_last_1m'] > 0):
- if($mails_sent['in_last_1m'] < 3 && $testing):
- $warning = sprintf("We already sent %d mail to this recipient in the last minute. An email was sent, because you're currently testing, but it would have been delayed for a real user, to avoid allegations of spamming.", $mails_sent['in_last_1m']);
- else:
- $error = sprintf("We already sent %d mail to this recipient in the last minute. No email was sent.", $mails_sent['in_last_1m']);
- endif;
- elseif ($mails_sent['in_last_10m'] > 1):
- if($mails_sent['in_last_10m'] < 10 && $testing):
- $warning = sprintf("We already sent %d mail to this recipient in the last 10 minutes. An email was sent, because you're currently testing, but it would have been delayed for a real user, to avoid allegations of spamming.", $mails_sent['in_last_10m']);
- else:
- $error = sprintf("We already sent %d mail to this recipient in the last 10 minutes. No email was sent.", $mails_sent['in_last_10m']);
- endif;
- elseif ($mails_sent['in_last_1h'] > 2):
- if($mails_sent['in_last_1h'] < 10 && $testing):
- $warning = sprintf("We already sent %d mails to this recipient in the last hour. An email was sent, because you're currently testing, but it would have been delayed for a real user, to avoid allegations of spamming.", $mails_sent['in_last_1h']);
- else:
- $error = sprintf("We already sent %d mails to this recipient in the last hour. No email was sent.", $mails_sent['in_last_1h']);
- endif;
- elseif ($mails_sent['in_last_1d'] > 9 && !$testing):
- $error = sprintf("We already sent %d mails to this recipient in the last day. No email was sent.", $mails_sent['in_last_1d']);
- elseif ($mails_sent['in_last_1w'] > 60 && !$testing):
- $error = sprintf("We already sent %d mails to this recipient in the last week. No email was sent.", $mails_sent['in_last_1w']);
- endif;
- else:
- if ($mails_sent['in_last_1m'] > 1 || $mails_sent['in_last_1d'] > 100):
- $error = sprintf("Too many emails are being sent to the study administrator, %d mails today. Please wait a little.", $mails_sent['in_last_1d']);
- endif;
- endif;
-
- if ($error !== null) {
- $error = "Session: {$this->session}:\n {$error}";
- alert(nl2br($error), 'alert-danger');
- return false;
- }
-
- if ($warning !== null) {
- $warning = "Session: {$this->session}:\n {$warning}";
- alert(nl2br($warning), 'alert-info');
- }
-
- // if formr is configured to use the email queue then add mail to queue and return
- if (Config::get('email.use_queue', false) === true && filter_var($this->recipient, FILTER_VALIDATE_EMAIL)) {
- $this->mail_sent = $this->dbh->insert('survey_email_queue', array(
- 'subject' => $this->getSubject(),
- 'message' => $this->getBody(),
- 'recipient' => $this->recipient,
- 'created' => mysql_datetime(),
- 'account_id' => (int) $this->account_id,
- 'meta' => json_encode(array(
- 'session_id' => $this->session_id,
- 'email_id' => $this->id,
- 'embedded_images' => $this->images,
- 'attachments' => ''
- )),
- ));
- return $this->mail_sent;
- }
-
- $mail = $acc->makeMailer();
-
-// if($this->html)
- $mail->IsHTML(true);
-
- $mail->AddAddress($this->recipient);
- $mail->Subject = $this->getSubject();
- $mail->Body = $this->getBody();
-
- if(filter_var($this->recipient, FILTER_VALIDATE_EMAIL) AND $mail->Body !== false AND $mail->Subject !== false):
- foreach ($this->images AS $image_id => $image):
- $local_image = APPLICATION_ROOT . 'tmp/' . uniqid() . $image_id;
- copy($image, $local_image);
- register_shutdown_function(create_function('', "unlink('{$local_image}');"));
-
- if (!$mail->AddEmbeddedImage($local_image, $image_id, $image_id, 'base64', 'image/png' )):
- alert('Email with the subject "' . h($mail->Subject) . '" was not sent to ' . h($this->recipient) . ':' . $mail->ErrorInfo, 'alert-danger'); - endif; - endforeach; - - if (!$mail->Send()): - alert('Email with the subject "' . h($mail->Subject) . '" was not sent to ' . h($this->recipient) . ':
' . $mail->ErrorInfo, 'alert-danger'); - else: - $this->mail_sent = true; - $this->logMail(); - endif; - else: - if(!filter_var($this->recipient, FILTER_VALIDATE_EMAIL)): - alert('Intended recipient was not a valid email address: '. $this->recipient, 'alert-danger'); - endif; - if($mail->Body === false): - alert('Email body empty or could not be dynamically generated.', 'alert-danger'); - endif; - if($mail->Subject === false): - alert('Email subject empty or could not be dynamically generated.', 'alert-danger'); - endif; - endif; - return $this->mail_sent; - } - - protected function numberOfEmailsSent() { - $log = $this->dbh->prepare("SELECT - SUM(created > DATE_SUB(NOW(), INTERVAL 1 MINUTE)) AS in_last_1m, - SUM(created > DATE_SUB(NOW(), INTERVAL 10 MINUTE)) AS in_last_10m, - SUM(created > DATE_SUB(NOW(), INTERVAL 1 HOUR)) AS in_last_1h, - SUM(created > DATE_SUB(NOW(), INTERVAL 1 DAY)) AS in_last_1d, - SUM(1) AS in_last_1w - FROM `survey_email_log` - WHERE recipient = :recipient AND created > DATE_SUB(NOW(), INTERVAL 7 DAY)"); - $log->bindParam(':recipient', $this->recipient); - $log->execute(); - return $log->fetch(PDO::FETCH_ASSOC); - } - - protected function logMail() { - if (!$this->session_id && $this->run_session) { - $unit = $this->run_session->getCurrentUnit(); - $session_id = $unit ? $unit['session_id'] : null; - } else { - $session_id = $this->session_id; - } - $query = "INSERT INTO `survey_email_log` (session_id, email_id, created, recipient) VALUES (:session_id, :email_id, NOW(), :recipient)"; - $this->dbh->exec($query, array( - 'session_id' => $session_id, - 'email_id' => $this->id, - 'recipient' => $this->recipient, - )); - } - - public function test() { - if (!$this->grabRandomSession()) { - return false; - } - global $user; - - $receiver = $user->getEmail(); - - echo "
Recipient
"; - $recipient_field = $this->getRecipientField('', true); - if($recipient_field instanceof OpenCPU_Session) { - echo opencpu_debug($recipient_field, null, 'text'); - } else { - echo $this->mostrecent . ": " . $recipient_field; - } - echo "Subject
"; - if($this->knittingNeeded($this->subject)): - echo $this->getParsedTextAdmin($this->subject); - else: - echo $this->getSubject(); - endif; - echo "Body
"; - - echo $this->getParsedBodyAdmin($this->body); - - echo "Attempt to send email
"; - - if($this->sendMail($receiver)): - echo "An email was sent to your own email address (". h($receiver). ").
"; - else: - echo "No email sent.
"; - endif; - - $results = $this->getSampleSessions(); - if ($results) { - - if ($this->recipient_field === null OR trim($this->recipient_field) == '') { - $this->recipient_field = 'survey_users$email'; - } - - $output = ' -| Code (Position) | -Test | -
|---|
Session {$this->session} cannot receive mails at this time
Enter a URL like http://example.org?code={{login_code}} and the user will be sent to that URL, replacing {{login_code}} with that user\'s code. Enter R-code to e.g. send more data along: paste0(\'http:example.org?code={{login_link}}&.
age=\', demographics$age)
-
- ';
-
- $inputgroup = isset($this->prepend) || isset($this->append);
- return Template::replace($template, array(
- 'classes_controls' => implode(' ', $this->classes_controls),
- 'input_group_open' => $inputgroup ? '
- %{input_group_open}
- %{prepended} %{input} %{appended}
- %{input_group_close}
-
- ' : '',
- 'input_group_close' => $inputgroup ? '
' : '',
- 'prepended' => $this->render_prepended(),
- 'input' => $this->render_input(),
- 'appended' => $this->render_appended(),
- ));
- }
-
- protected function render_item_view_input() {
- $template = '
-
-
-
-
-
-
- ';
- return Template::replace($template, array('id' => $this->id));
- }
-
- public function render() {
- if ($this->error) {
- $this->classes_wrapper[] = "has-error";
- }
- $this->classes_wrapper = array_unique($this->classes_wrapper);
- if ($this->data_showif) {
- $this->parent_attributes['data-showif'] = $this->js_showif;
- }
- $template = '
-
- %{item_content}
-
-
- ';
- return Template::replace($template, array(
- 'classes_wrapper' => implode(' ', $this->classes_wrapper),
- 'parent_attributes' => self::_parseAttributes($this->parent_attributes),
- 'item_content' => $this->render_inner() . $this->render_item_view_input(),
- 'title' => h($this->js_showif),
- 'name' => h($this->name),
- ));
- }
-
- public function render_error_tip() {
- $format = $this->error ? ' ' : '';
- return sprintf($format, h($this->error));
- }
-
- protected function splitValues() {
- if (isset($this->value_validated)) {
- if (is_array($this->value_validated)) {
- $this->presetValues = $this->value_validated;
- } else {
- $this->presetValues = array_map("trim", explode(",", $this->value_validated));
- }
- unset($this->input_attributes['value']);
- } elseif (isset($this->input_attributes['value'])) {
- $this->presetValues[] = $this->input_attributes['value'];
- } else {
- $this->presetValues = array();
- }
- }
-
- public function hide() {
- if (!$this->hidden) {
- $this->classes_wrapper[] = "hidden";
- $this->data_showif = true;
- $this->input_attributes['disabled'] = true; ## so it isn't submitted or validated
- $this->hidden = true; ## so it isn't submitted or validated
- }
- }
-
- public function alwaysInvalid() {
- $this->error = _('There were problems with openCPU.');
- if (!isset($this->input_attributes['class'])) {
- $this->input_attributes['class'] = '';
- }
- $this->input_attributes['class'] .= " always_invalid";
- }
-
- public function needsDynamicLabel($survey = null) {
- return $this->label_parsed === null;
- }
-
- public function getShowIf() {
- if (strstr($this->showif, "//js_only") !== false) {
- return "NA";
- }
-
- if ($this->hidden !== null) {
- return false;
- }
- if (trim($this->showif) != "") {
- return $this->showif;
- }
- return false;
- }
-
- public function needsDynamicValue() {
- $this->value = trim($this->value);
- if (!(is_formr_truthy($this->value))) {
- $this->presetValue = null;
- return false;
- }
- if (is_numeric($this->value)) {
- $this->input_attributes['value'] = $this->value;
- return false;
- }
-
- return true;
- }
-
- public function evaluateDynamicValue(Survey $survey) {
-
- }
-
- public function getValue(Survey $survey = null) {
- if ($survey && $this->value === 'sticky') {
- $this->value = "tail(na.omit({$survey->name}\${$this->name}),1)";
- }
- return trim($this->value);
- }
-
- /**
- * Set the visibility of an item based on show-if results returned from opencpu
- * $showif_result Can be an array or an interger value returned by ocpu. If a non-empty array then $showif_result[0] can have the following values
- * - NULL if the variable in $showif is Not Avaliable,
- * - TRUE if it avalaible and true,
- * - FALSE if it avalaible and not true
- * - An empty array if a problem occured with opencpu
- *
- * @param array|int $showif_result
- * @return null
- */
- public function setVisibility($showif_result) {
- if (!$showif_result) {
- return true;
- }
-
- $result = true;
- if (is_array($showif_result) && array_key_exists(0, $showif_result)) {
- $result = $showif_result[0];
- } elseif ($showif_result === array()) {
- notify_user_error("You made a mistake, writing a showif " . $this->showif . " that returns an element of length 0. The most common reason for this is to e.g. refer to data that does not exist. Valid return values for a showif are TRUE, FALSE and NULL/NA.", " There are programming problems in this survey.");
- $this->alwaysInvalid();
- $this->error = _('Incorrectly defined showif.');
- }
-
- if (!$result) {
- $this->hide();
- $this->probably_render = false;
- }
- // null means we can't determine clearly if item should be visible or not
- if ($result === null) {
- $this->probably_render = true;
- }
- return $result;
- }
-
- /**
- * Set the dynamic value computed on opencpu
- *
- * @param mixed $value Value
- * @return null
- */
- public function setDynamicValue($value) {
- if (!$value) {
- return;
- }
-
- $currentValue = $this->getValue();
- if ($value === array()) {
- notify_user_error("You made a mistake, writing a dynamic value " . h($currentValue) . " that returns an element of length 0. The most common reason for this is to e.g. refer to data that does not exist, e.g. misspell an item. Valid values need to have a length of one.", " There are programming problems related to zero-length dynamic values in this survey.");
- $this->openCPU_errors[$value] = _('Incorrectly defined value (zero length).');
- $this->alwaysInvalid();
- $value = null;
- } elseif ($value === null) {
- notify_user_error("You made a mistake, writing a dynamic value " . h($currentValue) . " that returns NA (missing). The most common reason for this is to e.g. refer to data that is not yet set, i.e. referring to questions that haven't been answered yet. To circumvent this, add a showif to your item, checking whether the item is answered yet using is.na(). Valid values need to have a length of one.", " There are programming problems related to null dynamic values in this survey.");
- $this->openCPU_errors[$value] = _('Incorrectly defined value (null).');
- $this->alwaysInvalid();
- } elseif (is_array($value) && array_key_exists(0, $value)) {
- $value = $value[0];
- }
-
- $this->input_attributes['value'] = $value;
- }
-
- public function getComputedValue() {
- if (isset($this->input_attributes['value'])) {
- return $this->input_attributes['value'];
- } else {
- return null;
- }
- }
-
- /**
- * Says if an item is visible or not. An item is visible if:
- * - It's hidden property is FALSE OR
- * - It's state cannot be determined at time of rendering
- *
- * @return boolean
- */
- public function isRendered() {
- return $this->requiresUserInput() && (!$this->hidden || $this->probably_render);
- }
-
- /**
- * Says if an item requires user input.
- *
- * @return boolean
- */
- public function requiresUserInput() {
- return !$this->no_user_input_required;
- }
-
- /**
- * Is an element hidden in DOM but rendered?
- *
- * @return boolean
- */
- public function isHiddenButRendered() {
- return $this->hidden && $this->probably_render;
- }
-
- public function setChoices($choices) {
- $this->choices = $choices;
- }
-
- public function getReply($reply) {
- return $reply;
- }
-
- /**
- * Returns a space-delimited string with items of the $options array. If a key
- * of $options array happens to be one of those listed in `Helper::$_minimizedAttributes`
- *
- * And its value is one of:
- *
- * - '1' (string)
- * - 1 (integer)
- * - true (boolean)
- * - 'true' (string)
- *
- * Then the value will be reset to be identical with key's name.
- * If the value is not one of these 3, the parameter is not output.
- *
- * 'escape' is a special option in that it controls the conversion of
- * attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
- *
- * If value for any option key is set to `null` or `false`, that option will be excluded from output.
- *
- * @param array $options Array of options.
- * @param array $exclude Array of options to be excluded, the options here will not be part of the return.
- * @param string $insertBefore String to be inserted before options.
- * @param string $insertAfter String to be inserted after options.
- * @return string Composed attributes.
- * @deprecated This method will be moved to HtmlHelper in 3.0
- */
- protected function _parseAttributes($options, $exclude = null, $insertBefore = ' ', $insertAfter = null) {
- if (!is_string($options)) {
- $options = (array) $options + array('escape' => true);
-
- if (!is_array($exclude)) {
- $exclude = array();
- }
-
- $exclude = array('escape' => true) + array_flip($exclude);
- $escape = $options['escape'];
- $attributes = array();
-
- foreach ($options as $key => $value) {
- if (!isset($exclude[$key]) && $value !== false && $value !== null) {
- $attributes[] = $this->_formatAttribute($key, $value, $escape);
- }
- }
- $out = implode(' ', $attributes);
- } else {
- $out = $options;
- }
- return $out ? $insertBefore . $out . $insertAfter : '';
- }
-
- /**
- * Formats an individual attribute, and returns the string value of the composed attribute.
- * Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'
- *
- * @param string $key The name of the attribute to create
- * @param string $value The value of the attribute to create.
- * @param boolean $escape Define if the value must be escaped
- * @return string The composed attribute.
- * @deprecated This method will be moved to HtmlHelper in 3.0
- */
- protected function _formatAttribute($key, $value, $escape = true) {
- if (is_array($value)) {
- $value = implode(' ', $value);
- }
- if (is_numeric($key)) {
- return sprintf($this->_minimizedAttributeFormat, $value, $value);
- }
- $truthy = array(1, '1', true, 'true', $key);
- $isMinimized = in_array($key, $this->_minimizedAttributes);
- if ($isMinimized && in_array($value, $truthy, true)) {
- return sprintf($this->_minimizedAttributeFormat, $key, $key);
- }
- if ($isMinimized) {
- return '';
- }
- return sprintf($this->_attributeFormat, $key, ($escape ? h($value) : $value));
- }
-
- protected function isSelectedOptionValue($expected = null, $actual = null) {
- if ($expected !== null && $actual !== null && $expected == $actual) {
- return true;
- }
- return false;
- }
-
-}
diff --git a/application/Model/Item/Blank.php b/application/Model/Item/Blank.php
index 9f4d99862..858b3c345 100644
--- a/application/Model/Item/Blank.php
+++ b/application/Model/Item/Blank.php
@@ -2,21 +2,20 @@
class Blank_Item extends Text_Item {
- public $type = 'blank';
- public $mysql_field = 'TEXT DEFAULT NULL';
+ public $type = 'blank';
+ public $mysql_field = 'TEXT DEFAULT NULL';
- public function render() {
- if ($this->error) {
- $this->classes_wrapper[] = "has-error";
- }
- $template = '%{text}
';
+ public function render() {
+ if ($this->error) {
+ $this->classes_wrapper[] = "has-error";
+ }
+ $template = '%{text}
';
- return Template::replace($template, array(
- 'classes_wrapper' => implode(' ', $this->classes_wrapper),
- 'showif' => $this->data_showif ? sprintf('data-showif="%s"', h($this->js_showif)) : '',
- 'text' => $this->label_parsed,
- ));
-
- }
+ return Template::replace($template, array(
+ 'classes_wrapper' => implode(' ', $this->classes_wrapper),
+ 'showif' => $this->data_showif ? sprintf('data-showif="%s"', h($this->js_showif)) : '',
+ 'text' => $this->label_parsed,
+ ));
+ }
}
diff --git a/application/Model/Item/Block.php b/application/Model/Item/Block.php
index 117a43bb9..50a95a242 100644
--- a/application/Model/Item/Block.php
+++ b/application/Model/Item/Block.php
@@ -2,12 +2,12 @@
class Block_Item extends Note_Item {
- public $type = 'block';
- public $input_attributes = array('type' => 'checkbox');
- public $optional = 0;
+ public $type = 'block';
+ public $input_attributes = array('type' => 'checkbox');
+ public $optional = 0;
- public function setMoreOptions() {
- $this->classes_wrapper[] = 'alert alert-danger';
- }
+ public function setMoreOptions() {
+ $this->classes_wrapper[] = 'alert alert-danger';
+ }
}
diff --git a/application/Model/Item/Browser.php b/application/Model/Item/Browser.php
index 1b9b2b607..dfa83e154 100644
--- a/application/Model/Item/Browser.php
+++ b/application/Model/Item/Browser.php
@@ -1,3 +1,5 @@
'hidden');
- public $no_user_input_required = true;
- public $mysql_field = 'TEXT DEFAULT NULL';
-
- public function render() {
- return $this->render_input();
- }
+ public $type = 'calculate';
+ public $input_attributes = array('type' => 'hidden');
+ public $no_user_input_required = true;
+ public $mysql_field = 'TEXT DEFAULT NULL';
+
+ public function render() {
+ return $this->render_input();
+ }
}
diff --git a/application/Model/Item/Cc.php b/application/Model/Item/Cc.php
index e5e18e40b..408d9458b 100644
--- a/application/Model/Item/Cc.php
+++ b/application/Model/Item/Cc.php
@@ -6,14 +6,13 @@
class Cc_Item extends Text_Item {
- public $type = 'cc';
- public $input_attributes = array('type' => 'cc', "data-luhn" => "");
- public $mysql_field = 'VARCHAR(255) DEFAULT NULL';
+ public $type = 'cc';
+ public $input_attributes = array('type' => 'cc', "data-luhn" => "");
+ public $mysql_field = 'VARCHAR(255) DEFAULT NULL';
+ protected $prepend = 'fa-credit-card';
- protected $prepend = 'fa-credit-card';
-
- protected function setMoreOptions() {
- $this->classes_input[] = 'form-control';
- }
+ protected function setMoreOptions() {
+ $this->classes_input[] = 'form-control';
+ }
}
diff --git a/application/Model/Item/Check.php b/application/Model/Item/Check.php
index 010b15162..96eab81cd 100644
--- a/application/Model/Item/Check.php
+++ b/application/Model/Item/Check.php
@@ -6,59 +6,59 @@
class Check_Item extends McMultiple_Item {
- public $mysql_field = 'TINYINT UNSIGNED DEFAULT NULL';
- public $choice_list = NULL;
- protected $hasChoices = false;
+ public $mysql_field = 'TINYINT UNSIGNED DEFAULT NULL';
+ public $choice_list = NULL;
+ protected $hasChoices = false;
- protected function setMoreOptions() {
- parent::setMoreOptions();
- $this->input_attributes['name'] = $this->name;
- }
+ protected function setMoreOptions() {
+ parent::setMoreOptions();
+ $this->input_attributes['name'] = $this->name;
+ }
- protected function render_label() {
- $template = '';
+ protected function render_label() {
+ $template = '';
- return Template::replace($template, array(
- 'class' => implode(' ', $this->classes_label),
- 'error' => $this->render_error_tip(),
- 'text' => $this->label_parsed,
- 'id' => $this->id,
- ));
- }
+ return Template::replace($template, array(
+ 'class' => implode(' ', $this->classes_label),
+ 'error' => $this->render_error_tip(),
+ 'text' => $this->label_parsed,
+ 'id' => $this->id,
+ ));
+ }
- public function validateInput($reply) {
- if (!in_array($reply, array(0, 1))) {
- $this->error = __("You chose an option '%s' that is not permitted.", h($reply));
- }
- $reply = parent::validateInput($reply);
- return $reply ? 1 : 0;
- }
+ public function validateInput($reply) {
+ if (!in_array($reply, array(0, 1))) {
+ $this->error = __("You chose an option '%s' that is not permitted.", h($reply));
+ }
+ $reply = parent::validateInput($reply);
+ return $reply ? 1 : 0;
+ }
- public function getReply($reply) {
- return $reply ? 1 : 0;
- }
+ public function getReply($reply) {
+ return $reply ? 1 : 0;
+ }
- protected function render_input() {
- if (!empty($this->input_attributes['value']) || !empty($this->value_validated)) {
- $this->input_attributes['checked'] = true;
- } else {
- $this->input_attributes['checked'] = false;
- }
- unset($this->input_attributes['value']);
+ protected function render_input() {
+ if (!empty($this->input_attributes['value']) || !empty($this->value_validated)) {
+ $this->input_attributes['checked'] = true;
+ } else {
+ $this->input_attributes['checked'] = false;
+ }
+ unset($this->input_attributes['value']);
- $template = '
+ $template = '
-
+
';
- return Template::replace($template, array(
- 'id' => $this->id,
- 'class' => $this->js_hidden ? ' js_hidden' : '',
- 'attributes' => self::_parseAttributes($this->input_attributes, array('id', 'type', 'required')),
- 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id')),
- ));
- }
+ return Template::replace($template, array(
+ 'id' => $this->id,
+ 'class' => $this->js_hidden ? ' js_hidden' : '',
+ 'attributes' => self::_parseAttributes($this->input_attributes, array('id', 'type', 'required')),
+ 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id')),
+ ));
+ }
}
diff --git a/application/Model/Item/CheckButton.php b/application/Model/Item/CheckButton.php
index deb9db9f5..9a2b41f60 100644
--- a/application/Model/Item/CheckButton.php
+++ b/application/Model/Item/CheckButton.php
@@ -2,29 +2,29 @@
class CheckButton_Item extends Check_Item {
- public $mysql_field = 'TINYINT UNSIGNED DEFAULT NULL';
- protected $js_hidden = true;
+ public $mysql_field = 'TINYINT UNSIGNED DEFAULT NULL';
+ protected $js_hidden = true;
- protected function setMoreOptions() {
- parent::setMoreOptions();
- $this->classes_wrapper[] = 'btn-check';
- }
+ protected function setMoreOptions() {
+ parent::setMoreOptions();
+ $this->classes_wrapper[] = 'btn-check';
+ }
- protected function render_label() {
- $template = '';
- return Template::replace($template, array(
- 'class' => implode(' ', $this->classes_label),
- 'error' => $this->render_error_tip(),
- 'text' => $this->label_parsed,
- ));
- }
+ protected function render_label() {
+ $template = '';
+ return Template::replace($template, array(
+ 'class' => implode(' ', $this->classes_label),
+ 'error' => $this->render_error_tip(),
+ 'text' => $this->label_parsed,
+ ));
+ }
- protected function render_appended() {
- $template = '
+ protected function render_appended() {
+ $template = '
';
- return sprintf($ret, $this->name);
- }
+ return sprintf($ret, $this->name);
+ }
- protected function render_appended() {
- $ret = '
+ protected function render_appended() {
+ $ret = '
';
- return sprintf($ret, $this->id);
- }
+ return sprintf($ret, $this->id);
+ }
}
diff --git a/application/Model/Item/Get.php b/application/Model/Item/Get.php
index cf394cb4d..52426f0ab 100644
--- a/application/Model/Item/Get.php
+++ b/application/Model/Item/Get.php
@@ -2,43 +2,58 @@
class Get_Item extends Item {
- public $type = 'get';
- public $input_attributes = array('type' => 'hidden');
- public $no_user_input_required = true;
- public $probably_render = true;
- public $mysql_field = 'TEXT DEFAULT NULL';
- protected $hasChoices = false;
- private $get_var = 'referred_by';
-
- protected function setMoreOptions() {
- if (isset($this->type_options_array) && is_array($this->type_options_array)) {
- if (count($this->type_options_array) == 1) {
- $this->get_var = trim(current($this->type_options_array));
- }
- }
-
- $this->input_attributes['value'] = '';
- $request = new Request($_GET);
- if (($value = $request->getParam($this->get_var)) !== null) {
- $this->input_attributes['value'] = $value;
- $this->value = $value;
- $this->value_validated = $value;
- }
- }
-
- public function validate() {
- if (!preg_match('/^[A-Za-z0-9_]+$/', $this->get_var)) {
- $this->val_errors[] = __('Problem with variable %s "get %s". The part after get can only contain a-Z0-9 and the underscore.', $this->name, $this->get_var);
- }
- return parent::validate();
- }
-
- public function render() {
- return $this->render_input();
- }
-
- public function needsDynamicValue() {
- return false;
- }
+ public $type = 'get';
+ public $input_attributes = array('type' => 'hidden');
+ public $no_user_input_required = true;
+ public $probably_render = true;
+ public $mysql_field = 'TEXT DEFAULT NULL';
+ protected $hasChoices = false;
+ private $get_var = 'referred_by';
+
+ protected function setMoreOptions() {
+ if (isset($this->type_options_array) && is_array($this->type_options_array)) {
+ if (count($this->type_options_array) == 1) {
+ $this->get_var = trim(current($this->type_options_array));
+ }
+ }
+
+ $this->input_attributes['value'] = '';
+ $request = new Request($_GET);
+ $value = $request->getParam($this->get_var);
+
+ if ($value !== null && $value !== "") {
+ $this->input_attributes['value'] = $value;
+ $this->value = $value;
+ $this->value_validated = $value;
+ }
+ }
+
+ public function validate() {
+ if (!preg_match('/^[A-Za-z0-9_]+$/', $this->get_var)) {
+ $this->val_errors[] = __('Problem with variable %s "get %s". The part after get can only contain a-Z0-9 and the underscore.', $this->name, $this->get_var);
+ }
+ return parent::validate();
+ }
+
+ public function validateInput($reply) {
+ $this->reply = $reply;
+ if (!$this->optional && (($reply === null || $reply === false || $reply === array() || $reply === '') || (is_array($reply) && count($reply) === 1 && current($reply) === ''))) {
+ // missed a required field
+ $this->error = 'error (missing GET param): ' . $this->label_parsed;
+ $reply = null;
+ } elseif ($this->optional && $reply == '') {
+ $reply = null;
+ }
+
+ return $reply;
+ }
+
+ public function render() {
+ return $this->render_input();
+ }
+
+ public function needsDynamicValue() {
+ return false;
+ }
}
diff --git a/application/Model/Item/Hidden.php b/application/Model/Item/Hidden.php
index 58a5dc2b3..b3ab6b792 100644
--- a/application/Model/Item/Hidden.php
+++ b/application/Model/Item/Hidden.php
@@ -2,18 +2,18 @@
class Hidden_Item extends Item {
- public $type = 'hidden';
- public $mysql_field = 'TEXT DEFAULT NULL';
- public $input_attributes = array('type' => 'hidden');
- public $optional = 1;
+ public $type = 'hidden';
+ public $mysql_field = 'TEXT DEFAULT NULL';
+ public $input_attributes = array('type' => 'hidden');
+ public $optional = 1;
- public function setMoreOptions() {
- unset($this->input_attributes["required"]);
- $this->classes_wrapper[] = "hidden";
- }
+ public function setMoreOptions() {
+ unset($this->input_attributes["required"]);
+ $this->classes_wrapper[] = "hidden";
+ }
- public function render_inner() {
- return $this->render_input();
- }
+ public function render_inner() {
+ return $this->render_input();
+ }
}
diff --git a/application/Model/Item/Image.php b/application/Model/Item/Image.php
index 6f04dbfba..2cd9b66ad 100644
--- a/application/Model/Item/Image.php
+++ b/application/Model/Item/Image.php
@@ -2,11 +2,11 @@
class Image_Item extends File_Item {
- public $type = 'image';
- public $input_attributes = array('type' => 'file', 'accept' => "image/*;capture=camera");
- public $mysql_field = 'VARCHAR(1000) DEFAULT NULL';
- protected $file_endings = array('image/jpeg' => '.jpg', 'image/png' => '.png', 'image/gif' => '.gif', 'image/tiff' => '.tif');
- protected $embed_html = '
+
+ ';
+
+ $inputgroup = isset($this->prepend) || isset($this->append);
+ return Template::replace($template, array(
+ 'classes_controls' => implode(' ', $this->classes_controls),
+ 'input_group_open' => $inputgroup ? '
+ %{input_group_open}
+ %{prepended} %{input} %{appended}
+ %{input_group_close}
+
+ ' : '',
+ 'input_group_close' => $inputgroup ? '
' : '',
+ 'prepended' => $this->render_prepended(),
+ 'input' => $this->render_input(),
+ 'appended' => $this->render_appended(),
+ ));
+ }
+
+ protected function render_item_view_input() {
+ $template = '
+
+
+
+
+
+
+ ';
+ return Template::replace($template, array('id' => $this->id));
+ }
+
+ public function render() {
+ if ($this->error) {
+ $this->classes_wrapper[] = "has-error";
+ }
+ $this->classes_wrapper = array_unique($this->classes_wrapper);
+ if ($this->data_showif) {
+ $this->parent_attributes['data-showif'] = $this->js_showif;
+ }
+ $template = '
+
+ %{item_content}
+
+
+ ';
+ return Template::replace($template, array(
+ 'classes_wrapper' => implode(' ', $this->classes_wrapper),
+ 'parent_attributes' => self::_parseAttributes($this->parent_attributes),
+ 'item_content' => $this->render_inner() . $this->render_item_view_input(),
+ 'title' => h($this->js_showif),
+ 'name' => h($this->name),
+ ));
+ }
+
+ public function render_error_tip() {
+ $format = $this->error ? ' ' : '';
+ return sprintf($format, h($this->error));
+ }
+
+ protected function splitValues() {
+ if (isset($this->value_validated)) {
+ if (is_array($this->value_validated)) {
+ $this->presetValues = $this->value_validated;
+ } else {
+ $this->presetValues = array_map("trim", explode(",", $this->value_validated));
+ }
+ unset($this->input_attributes['value']);
+ } elseif (isset($this->input_attributes['value'])) {
+ $this->presetValues[] = $this->input_attributes['value'];
+ } else {
+ $this->presetValues = array();
+ }
+ }
+
+ public function hide() {
+ if (!$this->hidden) {
+ $this->classes_wrapper[] = "hidden";
+ $this->data_showif = true;
+ $this->input_attributes['disabled'] = true; ## so it isn't submitted or validated
+ $this->hidden = true; ## so it isn't submitted or validated
+ }
+ }
+
+ public function alwaysInvalid() {
+ $this->error = _('There were problems with openCPU.');
+ if (!isset($this->input_attributes['class'])) {
+ $this->input_attributes['class'] = '';
+ }
+ $this->input_attributes['class'] .= " always_invalid";
+ }
+
+ public function needsDynamicLabel($vars = [], $context = null) {
+ return $this->label_parsed === null;
+ }
+
+ public function getShowIf() {
+ if ($this->showif && strstr($this->showif, "//js_only") !== false) {
+ return "NA";
+ }
+
+ if ($this->hidden !== null) {
+ return false;
+ }
+ if (trim((string)$this->showif) != "") {
+ return $this->showif;
+ }
+ return false;
+ }
+
+ public function needsDynamicValue() {
+ $this->value = trim((string) $this->value);
+ if (!(is_formr_truthy($this->value))) {
+ $this->presetValue = null;
+ return false;
+ }
+ if (is_numeric($this->value)) {
+ $this->input_attributes['value'] = $this->value;
+ return false;
+ }
+
+ return true;
+ }
+
+ public function evaluateDynamicValue(SurveyStudy $survey) {
+
+ }
+
+ public function getValue(SurveyStudy $survey = null) {
+ if ($survey && $this->value === 'sticky') {
+ $this->value = "tail(na.omit({$survey->name}\${$this->name}),1)";
+ }
+ return trim($this->value);
+ }
+
+ /**
+ * Set the visibility of an item based on show-if results returned from opencpu
+ * $showif_result Can be an array or an interger value returned by ocpu. If a non-empty array then $showif_result[0] can have the following values
+ * - NULL if the variable in $showif is Not Avaliable,
+ * - TRUE if it avalaible and true,
+ * - FALSE if it avalaible and not true
+ * - An empty array if a problem occured with opencpu
+ *
+ * @param array|int $showif_result
+ * @return null
+ */
+ public function setVisibility($showif_result) {
+ if (!$showif_result) {
+ return true;
+ }
+
+ $result = true;
+ if (is_array($showif_result) && array_key_exists(0, $showif_result)) {
+ $result = $showif_result[0];
+ } elseif ($showif_result === array()) {
+ notify_user_error("You made a mistake, writing a showif " . $this->showif . " that returns an element of length 0. The most common reason for this is to e.g. refer to data that does not exist. Valid return values for a showif are TRUE, FALSE and NULL/NA.", " There are programming problems in this survey.");
+ $this->alwaysInvalid();
+ $this->error = _('Incorrectly defined showif.');
+ }
+
+ if (!$result) {
+ $this->hide();
+ $this->probably_render = false;
+ }
+ // null means we can't determine clearly if item should be visible or not
+ if ($result === null) {
+ $this->probably_render = true;
+ }
+ return $result;
+ }
+
+ /**
+ * Set the dynamic value computed on opencpu
+ *
+ * @param mixed $value Value
+ * @return null
+ */
+ public function setDynamicValue($value) {
+ if (!$value) {
+ return;
+ }
+
+ $currentValue = $this->getValue();
+ if ($value === array()) {
+ notify_user_error("You made a mistake, writing a dynamic value " . h($currentValue) . " that returns an element of length 0. The most common reason for this is to e.g. refer to data that does not exist, e.g. misspell an item. Valid values need to have a length of one.", " There are programming problems related to zero-length dynamic values in this survey.");
+ $this->openCPU_errors[$value] = _('Incorrectly defined value (zero length).');
+ $this->alwaysInvalid();
+ $value = null;
+ } elseif ($value === null) {
+ notify_user_error("You made a mistake, writing a dynamic value " . h($currentValue) . " that returns NA (missing). The most common reason for this is to e.g. refer to data that is not yet set, i.e. referring to questions that haven't been answered yet. To circumvent this, add a showif to your item, checking whether the item is answered yet using is.na(). Valid values need to have a length of one.", " There are programming problems related to null dynamic values in this survey.");
+ $this->openCPU_errors[$value] = _('Incorrectly defined value (null).');
+ $this->alwaysInvalid();
+ } elseif (is_array($value) && array_key_exists(0, $value)) {
+ $value = $value[0];
+ }
+
+ $this->input_attributes['value'] = $value;
+ }
+
+ public function getComputedValue() {
+ if (isset($this->input_attributes['value'])) {
+ return $this->input_attributes['value'];
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Says if an item is visible or not. An item is visible if:
+ * - It's hidden property is FALSE OR
+ * - It's state cannot be determined at time of rendering
+ *
+ * @return boolean
+ */
+ public function isRendered() {
+ return $this->requiresUserInput() && (!$this->hidden || $this->probably_render);
+ }
+
+ /**
+ * Says if an item requires user input.
+ *
+ * @return boolean
+ */
+ public function requiresUserInput() {
+ return !$this->no_user_input_required;
+ }
+
+ /**
+ * Is an element hidden in DOM but rendered?
+ *
+ * @return boolean
+ */
+ public function isHiddenButRendered() {
+ return $this->hidden && $this->probably_render;
+ }
+
+ public function setChoices($choices) {
+ $this->choices = $choices;
+ }
+
+ public function getReply($reply) {
+ return $reply;
+ }
+
+ /**
+ * Returns a space-delimited string with items of the $options array. If a key
+ * of $options array happens to be one of those listed in `Helper::$_minimizedAttributes`
+ *
+ * And its value is one of:
+ *
+ * - '1' (string)
+ * - 1 (integer)
+ * - true (boolean)
+ * - 'true' (string)
+ *
+ * Then the value will be reset to be identical with key's name.
+ * If the value is not one of these 3, the parameter is not output.
+ *
+ * 'escape' is a special option in that it controls the conversion of
+ * attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
+ *
+ * If value for any option key is set to `null` or `false`, that option will be excluded from output.
+ *
+ * @param array $options Array of options.
+ * @param array $exclude Array of options to be excluded, the options here will not be part of the return.
+ * @param string $insertBefore String to be inserted before options.
+ * @param string $insertAfter String to be inserted after options.
+ * @return string Composed attributes.
+ */
+ protected function _parseAttributes($options, $exclude = null, $insertBefore = ' ', $insertAfter = null) {
+ if (!is_string($options)) {
+ $options = (array) $options + array('escape' => true);
+
+ if (!is_array($exclude)) {
+ $exclude = array();
+ }
+
+ $exclude = array('escape' => true) + array_flip($exclude);
+ $escape = $options['escape'];
+ $attributes = array();
+
+ foreach ($options as $key => $value) {
+ if (!isset($exclude[$key]) && $value !== false && $value !== null) {
+ $attributes[] = $this->_formatAttribute($key, $value, $escape);
+ }
+ }
+ $out = implode(' ', $attributes);
+ } else {
+ $out = $options;
+ }
+ return $out ? $insertBefore . $out . $insertAfter : '';
+ }
+
+ /**
+ * Formats an individual attribute, and returns the string value of the composed attribute.
+ * Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'
+ *
+ * @param string $key The name of the attribute to create
+ * @param string $value The value of the attribute to create.
+ * @param boolean $escape Define if the value must be escaped
+ * @return string The composed attribute.
+ */
+ protected function _formatAttribute($key, $value, $escape = true) {
+ if (is_array($value)) {
+ $value = implode(' ', $value);
+ }
+ if (is_numeric($key)) {
+ return sprintf($this->_minimizedAttributeFormat, $value, $value);
+ }
+ $truthy = array(1, '1', true, 'true', $key);
+ $isMinimized = in_array($key, $this->_minimizedAttributes);
+ if ($isMinimized && in_array($value, $truthy, true)) {
+ return sprintf($this->_minimizedAttributeFormat, $key, $key);
+ }
+ if ($isMinimized) {
+ return '';
+ }
+ return sprintf($this->_attributeFormat, $key, ($escape ? h($value) : $value));
+ }
+
+ protected function isSelectedOptionValue($expected = null, $actual = null) {
+ if ($expected !== null && $actual !== null && $expected == $actual) {
+ return true;
+ }
+ return false;
+ }
+
+}
diff --git a/application/Model/Item/Letters.php b/application/Model/Item/Letters.php
index a9e266e04..6d9ef666b 100644
--- a/application/Model/Item/Letters.php
+++ b/application/Model/Item/Letters.php
@@ -2,13 +2,13 @@
class Letters_Item extends Text_Item {
- public $type = 'letters';
- public $input_attributes = array('type' => 'text');
- public $mysql_field = 'TEXT DEFAULT NULL';
-
- protected function setMoreOptions() {
- $this->input_attributes['pattern'] = "[A-Za-züäöß.;,!: ]+";
- return parent::setMoreOptions();
- }
+ public $type = 'letters';
+ public $input_attributes = array('type' => 'text');
+ public $mysql_field = 'TEXT DEFAULT NULL';
+
+ protected function setMoreOptions() {
+ $this->input_attributes['pattern'] = "[A-Za-züäöß.;,!: ]+";
+ return parent::setMoreOptions();
+ }
}
diff --git a/application/Model/Item/Mc.php b/application/Model/Item/Mc.php
index 5482f5b78..7dd1afb68 100644
--- a/application/Model/Item/Mc.php
+++ b/application/Model/Item/Mc.php
@@ -5,113 +5,112 @@
*/
class Mc_Item extends Item {
- public $type = 'mc';
- public $lower_text = '';
- public $upper_text = '';
- public $input_attributes = array('type' => 'radio');
- public $mysql_field = 'TINYINT UNSIGNED DEFAULT NULL';
- protected $hasChoices = true;
-
- public function validateInput($reply) {
- if (!($this->optional && $reply == '') && !empty($this->choices) && // check
- ( is_string($reply) && !in_array($reply, array_keys($this->choices)) ) || // mc
- ( is_array($reply) && ($diff = array_diff($reply, array_keys($this->choices))) && !empty($diff) && current($diff) !== '' ) // mc_multiple
- ) { // invalid multiple choice answer
- if (isset($diff)) {
- $problem = $diff;
- } else {
- $problem = $reply;
- }
-
- if (is_array($problem)) {
- $problem = implode("', '", $problem);
- }
-
- $this->error = __("You chose an option '%s' that is not permitted.", h($problem));
- }
- return parent::validateInput($reply);
- }
-
- protected function render_label() {
- $template = '';
-
- return Template::replace($template, array(
- 'class' => implode(' ', $this->classes_label),
- 'error' => $this->render_error_tip(),
- 'text' => $this->label_parsed,
- ));
- }
-
- protected function render_input() {
-
- $this->splitValues();
-
- $ret = '
+ public $type = 'mc';
+ public $lower_text = '';
+ public $upper_text = '';
+ public $input_attributes = array('type' => 'radio');
+ public $mysql_field = 'TINYINT UNSIGNED DEFAULT NULL';
+ protected $hasChoices = true;
+
+ public function validateInput($reply) {
+ if (!($this->optional && $reply == '') && !empty($this->choices) && // check
+ ( is_string($reply) && !in_array($reply, array_keys($this->choices)) ) || // mc
+ ( is_array($reply) && ($diff = array_diff($reply, array_keys($this->choices))) && !empty($diff) && current($diff) !== '' ) // mc_multiple
+ ) { // invalid multiple choice answer
+ if (isset($diff)) {
+ $problem = $diff;
+ } else {
+ $problem = $reply;
+ }
+
+ if (is_array($problem)) {
+ $problem = implode("', '", $problem);
+ }
+
+ $this->error = __("You chose an option '%s' that is not permitted.", h($problem));
+ }
+ return parent::validateInput($reply);
+ }
+
+ protected function render_label() {
+ $template = '';
+
+ return Template::replace($template, array(
+ 'class' => implode(' ', $this->classes_label),
+ 'error' => $this->render_error_tip(),
+ 'text' => $this->label_parsed,
+ ));
+ }
+
+ protected function render_input() {
+
+ $this->splitValues();
+
+ $ret = '
';
- $opt_values = array_count_values($this->choices);
- if (isset($opt_values['']) && /* $opt_values[''] > 0 && */ current($this->choices) != '') { // and the first option isn't empty
- $this->label_first = true; // the first option label will be rendered before the radio button instead of after it.
- } else {
- $this->label_first = false;
- }
-
- if (mb_strpos(implode(' ', $this->classes_wrapper), 'mc-first-left') !== false) {
- $this->label_first = true;
- }
- $all_left = false;
- if (mb_strpos(implode(' ', $this->classes_wrapper), 'mc-all-left') !== false) {
- $all_left = true;
- }
-
- if ($this->value_validated) {
- $this->presetValues[] = $this->value_validated;
- }
-
- foreach ($this->choices as $value => $option) {
- // determine whether options needs to be checked
- if (in_array($value, $this->presetValues)) {
- $this->input_attributes['checked'] = true;
- } else {
- $this->input_attributes['checked'] = false;
- }
-
- $label = '
+ $opt_values = array_count_values($this->choices);
+ if (isset($opt_values['']) && /* $opt_values[''] > 0 && */ current($this->choices) != '') { // and the first option isn't empty
+ $this->label_first = true; // the first option label will be rendered before the radio button instead of after it.
+ } else {
+ $this->label_first = false;
+ }
+
+ if (mb_strpos(implode(' ', $this->classes_wrapper), 'mc-first-left') !== false) {
+ $this->label_first = true;
+ }
+ $all_left = false;
+ if (mb_strpos(implode(' ', $this->classes_wrapper), 'mc-all-left') !== false) {
+ $all_left = true;
+ }
+
+ if ($this->value_validated) {
+ $this->presetValues[] = $this->value_validated;
+ }
+
+ foreach ($this->choices as $value => $option) {
+ // determine whether options needs to be checked
+ if (in_array($value, $this->presetValues)) {
+ $this->input_attributes['checked'] = true;
+ } else {
+ $this->input_attributes['checked'] = false;
+ }
+
+ $label = '
';
- $label = Template::replace($label, array(
- 'id' => $this->id,
- 'value' => $value,
- 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id')),
- 'left_span' => ($this->label_first || $all_left) ? '' . $option . '' : '',
- 'right_span' => ($this->label_first || $all_left) ? ' ' : ' ' . $option . ''
- ));
-
- if (in_array('mc_vertical', $this->classes_wrapper)) {
- $ret .= '
';
-
- return Template::replace($ret, array(
- 'js_hidden' => $this->js_hidden ? ' js_hidden' : '',
- 'id' => $this->id,
- 'input_attributes' => self::_parseAttributes($this->input_attributes, array('type', 'id', 'required')),
- ));
- }
+ $label = Template::replace($label, array(
+ 'id' => $this->id,
+ 'value' => $value,
+ 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id')),
+ 'left_span' => ($this->label_first || $all_left) ? '' . $option . '' : '',
+ 'right_span' => ($this->label_first || $all_left) ? ' ' : ' ' . $option . ''
+ ));
+
+ if (in_array('mc_vertical', $this->classes_wrapper)) {
+ $ret .= '' . $label . '
';
- } else {
- $ret .= $label;
- }
-
- if ($this->label_first) {
- $this->label_first = false;
- }
-
- }
-
- $ret .= '' . $label . '
';
+ } else {
+ $ret .= $label;
+ }
+
+ if ($this->label_first) {
+ $this->label_first = false;
+ }
+ }
+
+ $ret .= '';
+
+ return Template::replace($ret, array(
+ 'js_hidden' => $this->js_hidden ? ' js_hidden' : '',
+ 'id' => $this->id,
+ 'input_attributes' => self::_parseAttributes($this->input_attributes, array('type', 'id', 'required')),
+ ));
+ }
}
diff --git a/application/Model/Item/McButton.php b/application/Model/Item/McButton.php
index b40c81425..ab709c96f 100644
--- a/application/Model/Item/McButton.php
+++ b/application/Model/Item/McButton.php
@@ -2,27 +2,27 @@
class McButton_Item extends Mc_Item {
- public $mysql_field = 'TINYINT UNSIGNED DEFAULT NULL';
- protected $js_hidden = true;
+ public $mysql_field = 'TINYINT UNSIGNED DEFAULT NULL';
+ protected $js_hidden = true;
- protected function setMoreOptions() {
- parent::setMoreOptions();
- $this->classes_wrapper[] = 'btn-radio';
- }
+ protected function setMoreOptions() {
+ parent::setMoreOptions();
+ $this->classes_wrapper[] = 'btn-radio';
+ }
- protected function render_appended() {
- $ret = '';
- foreach ($this->choices as $value => $option) {
- $tpl = '
+ protected function render_appended() {
+ $ret = '
';
- return $ret;
- }
+ return $ret;
+ }
}
diff --git a/application/Model/Item/McHeading.php b/application/Model/Item/McHeading.php
index 269c84cb3..d0f1acee2 100644
--- a/application/Model/Item/McHeading.php
+++ b/application/Model/Item/McHeading.php
@@ -2,71 +2,70 @@
class McHeading_Item extends Mc_Item {
- public $type = 'mc_heading';
- public $mysql_field = null;
- public $save_in_results_table = false;
+ public $type = 'mc_heading';
+ public $mysql_field = null;
+ public $save_in_results_table = false;
- protected function setMoreOptions() {
- $this->input_attributes['disabled'] = 'disabled';
- }
+ protected function setMoreOptions() {
+ $this->input_attributes['disabled'] = 'disabled';
+ }
- protected function render_label() {
- $template = '
+ protected function render_label() {
+ $template = '
';
+ foreach ($this->choices as $value => $option) {
+ $tpl = '
';
- $ret .= Template::replace($tpl, array('id' => $this->id, 'value' => $value, 'option' => $option));
- }
- $ret .= '
';
+ $ret .= Template::replace($tpl, array('id' => $this->id, 'value' => $value, 'option' => $option));
+ }
+ $ret .= '
%{error} %{text}
';
- return Template::replace($template, array(
- 'class' => implode(' ', $this->classes_label),
- 'error' => $this->render_error_tip(),
- 'text' => $this->label_parsed,
- 'name' => $this->name,
- ));
- }
+ return Template::replace($template, array(
+ 'class' => implode(' ', $this->classes_label),
+ 'error' => $this->render_error_tip(),
+ 'text' => $this->label_parsed,
+ 'name' => $this->name,
+ ));
+ }
- protected function render_input() {
- $ret = '';
+ protected function render_input() {
+ $ret = '
';
-
- return $ret;
- }
+ return $ret;
+ }
}
diff --git a/application/Model/Item/McMultiple.php b/application/Model/Item/McMultiple.php
index 6fadcfb5b..596a6d158 100644
--- a/application/Model/Item/McMultiple.php
+++ b/application/Model/Item/McMultiple.php
@@ -6,84 +6,84 @@
*/
class McMultiple_Item extends Mc_Item {
- public $type = 'mc_multiple';
- public $input_attributes = array('type' => 'checkbox');
- public $optional = 1;
- public $mysql_field = 'VARCHAR(40) DEFAULT NULL';
+ public $type = 'mc_multiple';
+ public $input_attributes = array('type' => 'checkbox');
+ public $optional = 1;
+ public $mysql_field = 'VARCHAR(40) DEFAULT NULL';
- protected function setMoreOptions() {
- $this->input_attributes['name'] = $this->name . '[]';
- }
+ protected function setMoreOptions() {
+ $this->input_attributes['name'] = $this->name . '[]';
+ }
- protected function chooseResultFieldBasedOnChoices() {
- $choices = array_keys($this->choices);
- $max = implode(", ", array_filter($choices));
- $maxlen = strlen($max);
- $this->mysql_field = 'VARCHAR (' . $maxlen . ') DEFAULT NULL';
- }
+ protected function chooseResultFieldBasedOnChoices() {
+ $choices = array_keys($this->choices);
+ $max = implode(", ", array_filter($choices));
+ $maxlen = strlen($max);
+ $this->mysql_field = 'VARCHAR (' . $maxlen . ') DEFAULT NULL';
+ }
- protected function render_input() {
- if (!$this->optional) {
- $this->input_attributes['data-grouprequired'] = '';
- }
- $this->splitValues();
+ protected function render_input() {
+ if (!$this->optional) {
+ $this->input_attributes['data-grouprequired'] = '';
+ }
+ $this->splitValues();
- $ret = '
+ $ret = '
';
- $this->input_attributes['type'] = 'radio';
- $opt_values = array_count_values($this->choices);
- if (isset($opt_values['']) && /* // if there are empty options $opt_values[''] > 0 && */ current($this->choices) != '') { // and the first option isn't empty
- $this->label_first = true; // the first option label will be rendered before the radio button instead of after it.
- } else {
- $this->label_first = false;
- }
+ $this->input_attributes['type'] = 'radio';
+ $opt_values = array_count_values($this->choices);
+ if (isset($opt_values['']) && /* // if there are empty options $opt_values[''] > 0 && */ current($this->choices) != '') { // and the first option isn't empty
+ $this->label_first = true; // the first option label will be rendered before the radio button instead of after it.
+ } else {
+ $this->label_first = false;
+ }
- if (mb_strpos(implode(" ", $this->classes_wrapper), 'mc_first_left') !== false) {
- $this->label_first = true;
- }
- $all_left = false;
- if (mb_strpos(implode(" ", $this->classes_wrapper), 'mc_all_left') !== false) {
- $all_left = true;
- }
+ if (mb_strpos(implode(" ", $this->classes_wrapper), 'mc_first_left') !== false) {
+ $this->label_first = true;
+ }
+ $all_left = false;
+ if (mb_strpos(implode(" ", $this->classes_wrapper), 'mc_all_left') !== false) {
+ $all_left = true;
+ }
- foreach ($this->choices as $value => $option) {
- $this->input_attributes['selected'] = $this->isSelectedOptionValue($value, $this->value_validated);
- $label = '
+ foreach ($this->choices as $value => $option) {
+ $this->input_attributes['selected'] = $this->isSelectedOptionValue($value, $this->value_validated);
+ $label = '
';
- $ret .= Template::replace($label, array(
- 'id' => $this->id,
- 'value' => $value,
- 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id')),
- 'left_span' => ($this->label_first || $all_left) ? $option . ' ' : '',
- 'right_span' => ($this->label_first || $all_left) ? " " : ' ' . $option,
- ));
+ $ret .= Template::replace($label, array(
+ 'id' => $this->id,
+ 'value' => $value,
+ 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id')),
+ 'left_span' => ($this->label_first || $all_left) ? $option . ' ' : '',
+ 'right_span' => ($this->label_first || $all_left) ? " " : ' ' . $option,
+ ));
+ }
- }
+ $ret .= '
';
- $ret .= '
';
- if (!$this->optional) {
- // this is a kludge, but if I don't add this, checkboxes are always circled red
- $ret .= '';
- }
+ if (!$this->optional) {
+ // this is a kludge, but if I don't add this, checkboxes are always circled red
+ $ret .= '';
+ }
- if ($this->value_validated) {
- $this->presetValues[] = $this->value_validated;
- }
+ if ($this->value_validated) {
+ $this->presetValues[] = $this->value_validated;
+ }
- foreach ($this->choices AS $value => $option) {
- // determine whether options needs to be checked
- if (in_array($value, $this->presetValues)) {
- $this->input_attributes['checked'] = true;
- } else {
- $this->input_attributes['checked'] = false;
- }
+ foreach ($this->choices AS $value => $option) {
+ // determine whether options needs to be checked
+ if (in_array($value, $this->presetValues)) {
+ $this->input_attributes['checked'] = true;
+ } else {
+ $this->input_attributes['checked'] = false;
+ }
- $label = '
+ $label = '
';
- $label = Template::replace($label, array(
- 'id' => $this->id,
- 'value' => $value,
- 'option' => $option,
- 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id', 'required', 'data-grouprequired')),
- ));
+ $label = Template::replace($label, array(
+ 'id' => $this->id,
+ 'value' => $value,
+ 'option' => $option,
+ 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id', 'required', 'data-grouprequired')),
+ ));
- if (in_array('mc_vertical', $this->classes_wrapper)) {
- $ret .= '
';
+ $ret .= '';
- return Template::replace($ret, array(
- 'js_hidden' => $this->js_hidden ? ' js_hidden' : '',
- 'id' => $this->id,
- 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id', 'type', 'required', 'data-grouprequired')),
- 'input_attributes_' => self::_parseAttributes($this->input_attributes, array('class', 'id', 'required')),
- ));
- }
+ return Template::replace($ret, array(
+ 'js_hidden' => $this->js_hidden ? ' js_hidden' : '',
+ 'id' => $this->id,
+ 'input_attributes' => self::_parseAttributes($this->input_attributes, array('id', 'type', 'required', 'data-grouprequired')),
+ 'input_attributes_' => self::_parseAttributes($this->input_attributes, array('class', 'id', 'required')),
+ ));
+ }
- public function getReply($reply) {
- if (is_array($reply)) {
- $reply = implode(", ", array_filter($reply));
- }
- return $reply;
- }
+ public function getReply($reply) {
+ if (is_array($reply)) {
+ $reply = implode(", ", array_filter($reply));
+ }
+ return $reply;
+ }
}
diff --git a/application/Model/Item/McMultipleButton.php b/application/Model/Item/McMultipleButton.php
index 8b51d7a80..93dee8a99 100644
--- a/application/Model/Item/McMultipleButton.php
+++ b/application/Model/Item/McMultipleButton.php
@@ -2,28 +2,28 @@
class McMultipleButton_Item extends McMultiple_Item {
- public $mysql_field = 'VARCHAR (40) DEFAULT NULL';
- public $type = "mc_multiple_button";
- protected $js_hidden = true;
+ public $mysql_field = 'VARCHAR(40) DEFAULT NULL';
+ public $type = "mc_multiple_button";
+ protected $js_hidden = true;
- protected function setMoreOptions() {
- parent::setMoreOptions();
- $this->classes_wrapper[] = 'btn-checkbox';
- }
+ protected function setMoreOptions() {
+ parent::setMoreOptions();
+ $this->classes_wrapper[] = 'btn-checkbox';
+ }
- protected function render_appended() {
- $ret = '' . $label . '
';
- } else {
- $ret .= $label;
- }
- }
+ if (in_array('mc_vertical', $this->classes_wrapper)) {
+ $ret .= '' . $label . '
';
+ } else {
+ $ret .= $label;
+ }
+ }
- $ret .= '';
- foreach ($this->choices as $value => $option) {
- $tpl = '
+ protected function render_appended() {
+ $ret = '
';
- return $ret;
- }
+ return $ret;
+ }
}
diff --git a/application/Model/Item/Month.php b/application/Model/Item/Month.php
index eb012ca69..bba37f32e 100644
--- a/application/Model/Item/Month.php
+++ b/application/Model/Item/Month.php
@@ -2,10 +2,8 @@
class Month_Item extends Yearmonth_Item {
- public $type = 'month';
- public $input_attributes = array('type' => 'month' , 'placeholder' => 'yyyy-mm');
-
- //protected $prepend = 'fa-calendar-o';
+ public $type = 'month';
+ public $input_attributes = array('type' => 'month', 'placeholder' => 'yyyy-mm');
+ //protected $prepend = 'fa-calendar-o';
}
-
diff --git a/application/Model/Item/Note.php b/application/Model/Item/Note.php
index df690d87c..bd7a4842a 100644
--- a/application/Model/Item/Note.php
+++ b/application/Model/Item/Note.php
@@ -3,27 +3,27 @@
// notes are rendered at full width
class Note_Item extends Item {
- public $type = 'note';
- public $mysql_field = null;
- public $input_attributes = array('type' => 'hidden', "value" => 1);
- public $save_in_results_table = false;
- public $optional = 1;
+ public $type = 'note';
+ public $mysql_field = null;
+ public $input_attributes = array('type' => 'hidden', "value" => 1);
+ public $save_in_results_table = false;
+ public $optional = 1;
- protected function render_label() {
- $template = '';
+ foreach ($this->choices as $value => $option) {
+ $tpl = '
';
- $ret .= Template::replace($tpl, array('id' => $this->id, 'value' => $value, 'option' => $option));
- }
- $ret .= '
';
+ $ret .= Template::replace($tpl, array('id' => $this->id, 'value' => $value, 'option' => $option));
+ }
+ $ret .= '%{error} %{text}
';
+ protected function render_label() {
+ $template = '%{error} %{text}
';
- return Template::replace($template, array(
- 'class' => implode(' ', $this->classes_label),
- 'error' => $this->render_error_tip(),
- 'text' => $this->label_parsed,
- ));
- }
+ return Template::replace($template, array(
+ 'class' => implode(' ', $this->classes_label),
+ 'error' => $this->render_error_tip(),
+ 'text' => $this->label_parsed,
+ ));
+ }
- public function validateInput($reply) {
- if ($reply != 1) {
- $this->error = _("You can only answer notes by viewing them.");
- }
- return $reply;
- }
+ public function validateInput($reply) {
+ if ($reply != 1) {
+ $this->error = _("You can only answer notes by viewing them.");
+ }
+ return $reply;
+ }
}
diff --git a/application/Model/Item/NoteIframe.php b/application/Model/Item/NoteIframe.php
index 6ba4ae155..e08fb5ce5 100644
--- a/application/Model/Item/NoteIframe.php
+++ b/application/Model/Item/NoteIframe.php
@@ -3,25 +3,25 @@
// notes are rendered at full width
class NoteIframe_Item extends Note_Item {
- public $type = 'note_iframe';
- public $mysql_field = null;
- public $input_attributes = array('type' => 'hidden', "value" => 1);
- public $save_in_results_table = false;
+ public $type = 'note_iframe';
+ public $mysql_field = null;
+ public $input_attributes = array('type' => 'hidden', "value" => 1);
+ public $save_in_results_table = false;
- public function needsDynamicLabel($survey = null) {
- $ocpu_vars = $survey->getUserDataInRun($this->label, $survey->name);
- $ocpu_session = opencpu_knit_iframe($this->label, $ocpu_vars, true, $survey->name);
- if ($ocpu_session && !$ocpu_session->hasError()) {
- $iframesrc = $ocpu_session->getFiles("knit.html")['knit.html'];
- $this->label_parsed = ''.
- '
+ public function needsDynamicLabel($vars = [], $context = null) {
+
+ $ocpu_session = opencpu_knit_iframe($this->label, $vars, true, $context);
+ if ($ocpu_session && !$ocpu_session->hasError()) {
+ $iframesrc = $ocpu_session->getFiles("knit.html")['knit.html'];
+ $this->label_parsed = '' .
+ '
';
}
- return false;
- }
+ return false;
+ }
}
diff --git a/application/Model/Item/Number.php b/application/Model/Item/Number.php
index b9c8ec939..a6537bddf 100644
--- a/application/Model/Item/Number.php
+++ b/application/Model/Item/Number.php
@@ -5,121 +5,126 @@
* - the min/max stuff is confusing and will fail for real big numbers
* - spinbox is polyfilled in browsers that lack it
*/
-
class Number_Item extends Item {
- public $type = 'number';
- public $input_attributes = array('type' => 'number', 'min' => 0, 'max' => 10000000, 'step' => 1);
- public $mysql_field = 'INT UNSIGNED DEFAULT NULL';
-
- protected function setMoreOptions() {
- $this->classes_input[] = 'form-control';
- if (isset($this->type_options) && trim($this->type_options) != "") {
- $this->type_options_array = explode(",", $this->type_options, 3);
-
- $min = trim(reset($this->type_options_array));
- if (is_numeric($min) OR $min === 'any') {
- $this->input_attributes['min'] = $min;
- }
-
- $max = trim(next($this->type_options_array));
- if (is_numeric($max) OR $max === 'any') {
- $this->input_attributes['max'] = $max;
- }
-
- $step = trim(next($this->type_options_array));
- if (is_numeric($step) OR $step === 'any') {
- $this->input_attributes['step'] = $step;
- }
- }
-
- $multiply = 2;
- if ($this->input_attributes['min'] < 0) :
- $this->mysql_field = str_replace("UNSIGNED", "", $this->mysql_field);
- $multiply = 1;
- endif;
-
- if ($this->input_attributes['step'] === 'any' OR $this->input_attributes['min'] === 'any' OR $this->input_attributes['max'] === 'any'): // is any any
- $this->mysql_field = str_replace(array("INT"), "FLOAT", $this->mysql_field); // use FLOATing point accuracy
- else:
- if (
- (abs($this->input_attributes['min']) < ($multiply * 127) ) && ( abs($this->input_attributes['max']) < ($multiply * 127) )
- ):
- $this->mysql_field = preg_replace("/^INT\s/", "TINYINT ", $this->mysql_field);
- elseif (
- (abs($this->input_attributes['min']) < ($multiply * 32767) ) && ( abs($this->input_attributes['max']) < ($multiply * 32767) )
- ):
- $this->mysql_field = preg_replace("/^INT\s/", "SMALLINT ", $this->mysql_field);
- elseif (
- (abs($this->input_attributes['min']) < ($multiply * 8388608) ) && ( abs($this->input_attributes['max']) < ($multiply * 8388608) )
- ):
- $this->mysql_field = preg_replace("/^INT\s/", "MEDIUMINT ", $this->mysql_field);
- elseif (
- (abs($this->input_attributes['min']) < ($multiply * 2147483648) ) && ( abs($this->input_attributes['max']) < ($multiply * 2147483648) )
- ):
- $this->mysql_field = str_replace("INT", "INT", $this->mysql_field);
- elseif (
- (abs($this->input_attributes['min']) < ($multiply * 9223372036854775808) ) && ( abs($this->input_attributes['max']) < ($multiply * 9223372036854775808) )
- ):
- $this->mysql_field = preg_replace("/^INT\s/", "BIGINT ", $this->mysql_field);
- endif;
-
- // FIXME: why not use is_int()? why casting to int before strlen?
- if ((string) (int) $this->input_attributes['step'] != $this->input_attributes['step']): // step is integer?
- $before_point = max(strlen((int) $this->input_attributes['min']), strlen((int) $this->input_attributes['max'])); // use decimal with this many digits
- $after_point = strlen($this->input_attributes['step']) - 2;
- $d = $before_point + $after_point;
-
- $this->mysql_field = str_replace(array("TINYINT", "SMALLINT", "MEDIUMINT", "INT", "BIGINT"), "DECIMAL($d, $after_point)", $this->mysql_field);
- endif;
- endif;
- }
-
- public function validateInput($reply) { // fixme: input is not re-displayed after this
- $reply = trim(str_replace(",", ".", $reply));
- if (!$reply && $reply !== 0 && $this->optional) {
- return null;
- }
-
- if ($this->input_attributes['min'] !== 'any' && $reply < $this->input_attributes['min']) { // lower number than allowed
- $this->error = __("The minimum is %d.", $this->input_attributes['min']);
- } elseif ($this->input_attributes['max'] !== 'any' && $reply > $this->input_attributes['max']) { // larger number than allowed
- $this->error = __("The maximum is %d.", $this->input_attributes['max']);
- } elseif ($this->input_attributes['step'] !== 'any' AND
- abs(
- (round($reply / $this->input_attributes['step']) * $this->input_attributes['step']) // divide, round and multiply by step
- - $reply // should be equal to reply
- ) > 0.000000001 // with floats I have to leave a small margin of error
- ) {
- $this->error = __("Numbers have to be in steps of at least %d.", $this->input_attributes['step']);
- }
-
- return parent::validateInput($reply);
- }
-
- public function getReply($reply) {
- $reply = trim(str_replace(",", ".", $reply));
- if (!$reply && $reply !== 0 && $this->optional) {
- return null;
- }
- return $reply;
- }
-
- public function needsDynamicValue() {
- /**
- * If item is serving as a counter and already has a saved value then use that
- */
- if ($this->value_validated !== null && $this->isCounter()) {
- $this->input_attributes['value'] = $this->value_validated;
- return false;
- } else {
- // Use the default calulation
- return parent::needsDynamicValue();
- }
- }
-
- protected function isCounter() {
- return in_array('counter', $this->classes_wrapper);
- }
+ public $type = 'number';
+ public $input_attributes = array('type' => 'number', 'min' => 0, 'max' => 10000000, 'step' => 1);
+ public $mysql_field = 'INT UNSIGNED DEFAULT NULL';
+
+ protected function setMoreOptions() {
+ $this->classes_input[] = 'form-control';
+ if (isset($this->type_options) && trim($this->type_options) != "") {
+ $this->type_options_array = explode(",", $this->type_options, 3);
+
+ $min = trim(reset($this->type_options_array));
+ if (is_numeric($min) OR $min === 'any') {
+ $this->input_attributes['min'] = $min;
+ }
+
+ $max = trim(next($this->type_options_array));
+ if (is_numeric($max) OR $max === 'any') {
+ $this->input_attributes['max'] = $max;
+ }
+
+ $step = trim(next($this->type_options_array));
+ if (is_numeric($step) OR $step === 'any') {
+ $this->input_attributes['step'] = $step;
+ }
+ }
+
+ $multiply = 2;
+ if ($this->input_attributes['min'] < 0) :
+ $this->mysql_field = str_replace("UNSIGNED", "", $this->mysql_field);
+ $multiply = 1;
+ endif;
+
+ if ($this->input_attributes['step'] === 'any' OR $this->input_attributes['min'] === 'any' OR $this->input_attributes['max'] === 'any'): // is any any
+ $this->mysql_field = str_replace(array("INT"), "FLOAT", $this->mysql_field); // use FLOATing point accuracy
+ else:
+ if (
+ (abs($this->input_attributes['min']) < ($multiply * 127) ) && ( abs($this->input_attributes['max']) < ($multiply * 127) )
+ ):
+ $this->mysql_field = preg_replace("/^INT\s/", "TINYINT ", $this->mysql_field);
+ elseif (
+ (abs($this->input_attributes['min']) < ($multiply * 32767) ) && ( abs($this->input_attributes['max']) < ($multiply * 32767) )
+ ):
+ $this->mysql_field = preg_replace("/^INT\s/", "SMALLINT ", $this->mysql_field);
+ elseif (
+ (abs($this->input_attributes['min']) < ($multiply * 8388608) ) && ( abs($this->input_attributes['max']) < ($multiply * 8388608) )
+ ):
+ $this->mysql_field = preg_replace("/^INT\s/", "MEDIUMINT ", $this->mysql_field);
+ elseif (
+ (abs($this->input_attributes['min']) < ($multiply * 2147483648) ) && ( abs($this->input_attributes['max']) < ($multiply * 2147483648) )
+ ):
+ $this->mysql_field = str_replace("INT", "INT", $this->mysql_field);
+ elseif (
+ (abs($this->input_attributes['min']) < ($multiply * 9223372036854775808) ) && ( abs($this->input_attributes['max']) < ($multiply * 9223372036854775808) )
+ ):
+ $this->mysql_field = preg_replace("/^INT\s/", "BIGINT ", $this->mysql_field);
+ endif;
+
+ // FIXME: why not use is_int()? why casting to int before strlen?
+ if ((string) (int) $this->input_attributes['step'] != $this->input_attributes['step']): // step is integer?
+ $before_point = max(strlen((int) $this->input_attributes['min']), strlen((int) $this->input_attributes['max'])); // use decimal with this many digits
+ $after_point = strlen($this->input_attributes['step']) - 2;
+ $d = $before_point + $after_point;
+
+ $this->mysql_field = str_replace(array("TINYINT", "SMALLINT", "MEDIUMINT", "INT", "BIGINT"), "DECIMAL($d, $after_point)", $this->mysql_field);
+ endif;
+ endif;
+ }
+
+ protected function chooseResultFieldBasedOnChoices() {
+ }
+
+ public function validateInput($reply) { // fixme: input is not re-displayed after this
+ $reply = trim(str_replace(",", ".", $reply));
+ if (!$reply && $reply !== 0 && $this->optional) {
+ return null;
+ }
+
+ if ($this->input_attributes['min'] !== 'any' && $reply < $this->input_attributes['min']) { // lower number than allowed
+ $this->error = __("The minimum is %d.", $this->input_attributes['min']);
+ } elseif ($this->input_attributes['max'] !== 'any' && $reply > $this->input_attributes['max']) { // larger number than allowed
+ $this->error = __("The maximum is %d.", $this->input_attributes['max']);
+ } elseif ($this->input_attributes['step'] !== 'any' AND
+ abs(
+ (round($reply / $this->input_attributes['step']) * $this->input_attributes['step']) // divide, round and multiply by step
+ - $reply // should be equal to reply
+ ) > 0.000000001 // with floats I have to leave a small margin of error
+ ) {
+ $this->error = __("Numbers have to be in steps of at least %d.", $this->input_attributes['step']);
+ }
+
+ return parent::validateInput($reply);
+ }
+
+ public function getReply($reply) {
+ if ($reply === null) {
+ return null;
+ }
+ $reply = trim(str_replace(",", ".", $reply));
+ if (!$reply && $reply !== 0 && $this->optional) {
+ return null;
+ }
+ return $reply;
+ }
+
+ public function needsDynamicValue() {
+ /**
+ * If item is serving as a counter and already has a saved value then use that
+ */
+ if ($this->value_validated !== null && $this->isCounter()) {
+ $this->input_attributes['value'] = $this->value_validated;
+ return false;
+ } else {
+ // Use the default calulation
+ return parent::needsDynamicValue();
+ }
+ }
+
+ protected function isCounter() {
+ return in_array('counter', $this->classes_wrapper);
+ }
}
diff --git a/application/Model/Item/Random.php b/application/Model/Item/Random.php
index 13dfed914..4665bc2c8 100644
--- a/application/Model/Item/Random.php
+++ b/application/Model/Item/Random.php
@@ -2,29 +2,29 @@
class Random_Item extends Number_Item {
- public $type = 'random';
- public $input_attributes = array('type' => 'hidden', 'step' => 1);
- public $mysql_field = 'INT UNSIGNED DEFAULT NULL';
- public $no_user_input_required = true;
+ public $type = 'random';
+ public $input_attributes = array('type' => 'hidden', 'step' => 1, 'min' => 0, 'max' => 10000000);
+ public $mysql_field = 'INT UNSIGNED DEFAULT NULL';
+ public $no_user_input_required = true;
- protected function setMoreOptions() {
- parent::setMoreOptions();
- $this->input_attributes['value'] = $this->validateInput();
- }
+ protected function setMoreOptions() {
+ parent::setMoreOptions();
+ $this->input_attributes['value'] = $this->validateInput();
+ }
- public function validateInput($reply = '') {
- if (isset($this->input_attributes['min']) && isset($this->input_attributes['max'])) { // both limits specified
- $reply = mt_rand($this->input_attributes['min'], $this->input_attributes['max']);
- } elseif (!isset($this->input_attributes['min']) && !isset($this->input_attributes['max'])) { // neither limit specified
- $reply = mt_rand(0, 1);
- } else {
- $this->error = __("Both random minimum and maximum need to be specified");
- }
- return $reply;
- }
+ public function validateInput($reply = '') {
+ if (isset($this->input_attributes['min']) && isset($this->input_attributes['max'])) { // both limits specified
+ $reply = mt_rand($this->input_attributes['min'], $this->input_attributes['max']);
+ } elseif (!isset($this->input_attributes['min']) && !isset($this->input_attributes['max'])) { // neither limit specified
+ $reply = mt_rand(0, 1);
+ } else {
+ $this->error = __("Both random minimum and maximum need to be specified");
+ }
+ return $reply;
+ }
- public function getReply($reply) {
- return $this->input_attributes['value'];
- }
+ public function getReply($reply) {
+ return $this->input_attributes['value'];
+ }
}
diff --git a/application/Model/Item/Range.php b/application/Model/Item/Range.php
index 3854ab156..b6fea07cb 100644
--- a/application/Model/Item/Range.php
+++ b/application/Model/Item/Range.php
@@ -2,39 +2,38 @@
class Range_Item extends Number_Item {
- public $type = 'range';
- public $input_attributes = array('type' => 'range', 'min' => 0, 'max' => 100, 'step' => 1);
- public $mysql_field = 'INT UNSIGNED DEFAULT NULL';
-
- protected $hasChoices = true;
-
- protected function setMoreOptions() {
- $this->lower_text = current($this->choices);
- $this->upper_text = next($this->choices);
- parent::setMoreOptions();
-
- $this->classes_input = array_diff($this->classes_input, array('form-control'));
- }
-
- protected function render_input() {
- if ($this->value_validated) {
- $this->input_attributes['value'] = $this->value_validated;
- }
-
- $tpl = '%{left_label} %{right_label}';
-
- return Template::replace($tpl, array(
- 'left_label' => $this->render_pad_label(1, 'right'),
- 'input_attributes' => self::_parseAttributes($this->input_attributes, array('required')),
- 'right_label' => $this->render_pad_label(2, 'left'),
- ));
- }
-
- private function render_pad_label($choice, $pad) {
- if (isset($this->choices[$choice])) {
- return sprintf('', $pad, $this->choices[$choice]);
- }
- return '';
- }
+ public $type = 'range';
+ public $input_attributes = array('type' => 'range', 'min' => 0, 'max' => 100, 'step' => 1);
+ public $mysql_field = 'INT UNSIGNED DEFAULT NULL';
+ protected $hasChoices = true;
+
+ protected function setMoreOptions() {
+ $this->lower_text = current($this->choices);
+ $this->upper_text = next($this->choices);
+ parent::setMoreOptions();
+
+ $this->classes_input = array_diff($this->classes_input, array('form-control'));
+ }
+
+ protected function render_input() {
+ if ($this->value_validated) {
+ $this->input_attributes['value'] = $this->value_validated;
+ }
+
+ $tpl = '%{left_label} %{right_label}';
+
+ return Template::replace($tpl, array(
+ 'left_label' => $this->render_pad_label(1, 'right'),
+ 'input_attributes' => self::_parseAttributes($this->input_attributes, array('required')),
+ 'right_label' => $this->render_pad_label(2, 'left'),
+ ));
+ }
+
+ private function render_pad_label($choice, $pad) {
+ if (isset($this->choices[$choice])) {
+ return sprintf('', $pad, $this->choices[$choice]);
+ }
+ return '';
+ }
}
diff --git a/application/Model/Item/RangeTicks.php b/application/Model/Item/RangeTicks.php
index 793194a75..2f10ed2b8 100644
--- a/application/Model/Item/RangeTicks.php
+++ b/application/Model/Item/RangeTicks.php
@@ -5,26 +5,40 @@
*/
class RangeTicks_Item extends Number_Item {
- public $type = 'range_ticks';
- public $input_attributes = array('type' => 'range', 'step' => 1);
+ public $type = 'range_ticks';
+ public $input_attributes = array('type' => 'range', 'step' => 1, 'min' => 0, 'max' => 100);
+ protected $labels = array();
+ protected $left_label = '';
+ protected $right_labeel = '';
+ protected $hasChoices = true;
- protected $hasChoices = true;
+ public function setChoices($choices) {
+ $this->labels = $choices;
+ $this->left_label = $this->render_pad_label(1, 'right');
+ $this->right_labeel = $this->render_pad_label(2, 'left');
+ }
- protected function setMoreOptions() {
- $this->input_attributes['min'] = 0;
- $this->input_attributes['max'] = 100;
- $this->input_attributes['list'] = 'dlist' . $this->id;
- $this->input_attributes['data-range'] = '{"animate": true, "classes": "show-activevaluetooltip"}';
- $this->classes_input[] = "range-list";
+ protected function setMoreOptions() {
+ $this->input_attributes['min'] = 0;
+ $this->input_attributes['max'] = 100;
+ $this->input_attributes['list'] = 'dlist' . $this->id;
+ $this->input_attributes['data-range'] = '{"animate": true, "classes": "show-activevaluetooltip"}';
+ $this->classes_input[] = "range-list";
- $this->classes_wrapper[] = 'range_ticks_output';
+ $this->classes_wrapper[] = 'range_ticks_output';
- parent::setMoreOptions();
- $this->classes_input = array_diff($this->classes_input, array('form-control'));
- }
+ parent::setMoreOptions();
+ $this->classes_input = array_diff($this->classes_input, array('form-control'));
- protected function render_input() {
- $tpl = '
+ // Set actual choices based on defined range and step
+ $this->choices = array();
+ for ($i = $this->input_attributes['min']; $i <= $this->input_attributes['max']; $i = $i + $this->input_attributes['step']) {
+ $this->choices[(string)$i] = $i;
+ }
+ }
+
+ protected function render_input() {
+ $tpl = '
%{left_label}