+ *+ * + * Required: a title and at least one option. + * + *+ * * Option 1 + * * Option 2 **some wikimarkup** \\ is __allowed__! + * * Option 3 + * + *
Parameters
+ * auth="none" - everyone can vote with any username, (IPs will be recorded but not checked) + * auth="ip" - everyone can vote with any username, votes will be tracked by IP to prevent duplicate voting + * auth="user" - users must login with a valid dokuwiki user. This has the advantage, that users can + * edit their vote ("change their mind") later on. + * adminUser/adminGroups - Logged in adminUsers or members of the adminGroups can always edit and delete any entry. + * + * If type="single", then each user can choose only one option (round checkboxes will be shown). + * If type="multi", then each user can choose multiple options (square checkboxes will be shown). + * + * If the doodle is closed, then no one can vote anymore. The result will still be shown on the page. + * + * The doodle's data is saved in '', $choice); # two(!) backslashes for a newline + $choice = preg_replace('#\*\*(.*?)\*\*#', '\1', $choice); # bold + $choice = preg_replace('#__(.*?)__#', '\1', $choice); # underscore + $choice = preg_replace('#//(.*?)//#', '\1', $choice); # italic + $choices []= $choice; + } + } + //debout($choices); + return $choices; + } + + // ----- these fields will always be initialized at the beginning of the render function + // and can then be used in helper functions below. + public $params = array(); + public $choices = array(); + public $doodle = array(); + public $template = array(); // output values for doodle_template.php + + /** + * Read doodle data from file, + * add new vote if user just submitted one and + * create output xHTML from template + */ + function render($mode, &$renderer, $data) { + if ($mode != 'xhtml') return false; + + //debout("render: $mode"); + global $lang; + global $auth; + global $conf; + global $INFO; // needed for users real name + global $ACT; // action from $_REQUEST['do'] + global $ID; // name of current page + + $this->params = $data['params']; + $this->choices = $data['choices']; + $this->doodle = array(); + $this->template = array(); + + // prevent caching to ensure the poll results are fresh + $renderer->info['cache'] = false; + + // ----- read doodle data from file (if there are choices given and there is a file) + if (count($this->choices) > 0) { + $this->doodle = $this->readDoodleDataFromFile(); + } + //FIXME: count($choices) may be different from number of choices in $doodle data! + + // ----- FORM ACTIONS (only allowed when showing the page, not when editing) ----- + $formId = 'doodle__form__'.cleanID($this->params['title']); + if ($ACT == 'show' && $_REQUEST['formId'] == $formId ) { + // ---- cast new vote + if (!empty($_REQUEST['cast__vote'])) { + $this->castVote(); + } else + // ---- start editing an entry + if (!empty($_REQUEST['edit__entry']) ) { + $this->startEditEntry(); + } else + // ---- save changed entry + if (!empty($_REQUEST['change__vote']) ) { + $this->castVote(); + } else + // ---- delete an entry completely + if (!empty($_REQUEST['delete__entry']) ) { + $this->deleteEntry(); + } + } + + /******** Format of the $doodle array *********** + * The $doodle array maps fullnames (with html special characters masked) to an array of userData for this vote. + * Each sub array contains: + * 'username' loggin name if use was logged in + * 'choices' is an array of column indexes where user has voted !!! + * 'ip' ip of voting machine + * 'time' unix timestamp when vote was casted + + + $doodle = array( + 'Robert' => array( + 'username' => 'doogie' + 'choices' => array(0, 3), + 'ip' => '123.123.123.123', + 'time' => 1284970602 + ), + 'Peter' => array( + 'choices' => array(), + 'ip' => '222.122.111.1', + 'time' > 12849702333 + ), + 'Sabine' => array( + 'choices' => array(0, 1, 2, 3, 4), + 'ip' => '333.333.333.333', + 'time' => 1284970222 + ), + ); + */ + + // ---- fill $this->template variable for doodle_template.php (column by column) + $this->template['title'] = hsc($this->params['title']); + $this->template['choices'] = $this->choices; + $this->template['result'] = $this->params['closed'] ? $this->getLang('final_result') : $this->getLang('count'); + $this->template['doodleData'] = array(); // this will be filled with some HTML snippets + $this->template['formId'] = $formId; + + for($col = 0; $col < count($this->choices); $col++) { + $this->template['count'][$col] = 0; + foreach ($this->doodle as $fullname => $userData) { + if (!empty($userData['username'])) { + $this->template['doodleData']["$fullname"]['username'] = ' ('.$userData['username'].')'; + } + if (in_array($col, $userData['choices'])) { + $timeLoc = strftime($conf['dformat'], $userData['time']); // localized time of vote + $this->template['doodleData']["$fullname"]['choice'][$col] = + '
'.
+ ''.
+ ''.
+ ' 
'.
+ '';
+ }
+ }
+
+ // ---- calculates if user is allowed to vote
+ $this->template['inputTR'] = $this->getInputTR();
+
+ // ----- I am using PHP as a templating enginge here.
+ //debout("Template", $this->template);
+ ob_start();
+ include 'doodle_template.php'; // the array $template can be used inside doodle_template.php!
+ $doodle_table = ob_get_contents();
+ ob_end_clean();
+ $renderer->doc .= $doodle_table;
+ }
+
+ // --------------- FORM ACTIONS -----------
+ /**
+ * ACTION: cast a new vote
+ * or save a changed vote
+ * (If user is allowed to.)
+ */
+ function castVote() {
+ $fullname = hsc(trim($_REQUEST['fullname']));
+ $selected_indexes = $_REQUEST['selected_indexes']; // may not be set when all checkboxes are deseleted.
+ if (empty($selected_indexes)) {
+ $selected_indexes = array();
+ }
+
+ if (empty($fullname)) {
+ return;
+ }
+ //---- check if user is allowed to vote, according to 'auth' parameter
+
+ //if AUTH_USER, then user must be logged in
+ if ($this->params['auth'] == self::AUTH_USER && !$this->isLoggedIn()) {
+ $this->template['msg'] = $this->getLang('must_be_logged_in');
+ return;
+ }
+
+ //if AUTH_IP, then prevent duplicate votes by IP.
+ //Exception: If user is logged in he is always allowed to change the vote with his fullname, even if he is on another IP.
+ if ($this->params['auth'] == self::AUTH_IP && !$this->isLoggedIn() && !isset($_REQUEST['change__vote']) ) {
+ foreach($this->doodle as $existintFullname => $userData) {
+ if (strcmp($userData['ip'], $_SERVER['REMOTE_ADDR']) == 0) {
+ $this->template['msg'] = sprintf($this->getLang('ip_has_already_voted'), $_SERVER['REMOTE_ADDR']);
+ return;
+ }
+ }
+ }
+
+ //do not vote twice, unless change__vote is set
+ if (isset($this->doodle["$fullname"]) && !isset($_REQUEST['change__vote']) ) {
+ $this->template['msg'] = $this->getLang('you_voted_already');
+ return;
+ }
+
+ //check if change__vote is allowed
+ if (!empty($_REQUEST['change__vote']) &&
+ !$this->isAllowedToEditEntry($fullname))
+ {
+ $this->template['msg'] = $this->getLang('not_allowed_to_change');
+ return;
+ }
+
+ if (!empty($_SERVER['REMOTE_USER'])) {
+ $this->doodle["$fullname"]['username'] = $_SERVER['REMOTE_USER'];
+ }
+ $this->doodle["$fullname"]['choices'] = $selected_indexes;
+ $this->doodle["$fullname"]['time'] = time();
+ $this->doodle["$fullname"]['ip'] = $_SERVER['REMOTE_ADDR'];
+ $this->writeDoodleDataToFile();
+ $this->template['msg'] = $this->getLang('vote_saved');
+ }
+
+ /** ACTION: start editing an entry */
+ function startEditEntry() {
+ $fullname = hsc(trim($_REQUEST['edit__entry']));
+ if (empty($fullname) ||
+ !isset($this->doodle["$fullname"]) ||
+ !$this->isAllowedToEditEntry($fullname) ) return;
+
+ $this->template['editEntry']['fullname'] = $fullname;
+ $this->template['editEntry']['selected_indexes'] = $this->doodle["$fullname"]['choices'];
+ // $fullname will be shown in the input row
+ }
+
+ /** ACTION: delete an entry completely */
+ function deleteEntry() {
+ $fullname = hsc(trim($_REQUEST['delete__entry']));
+ if (empty($fullname) ||
+ !isset($this->doodle["$fullname"]) ||
+ !$this->isAllowedToEditEntry($fullname) ) return;
+
+ unset($this->doodle["$fullname"]);
+ $this->writeDoodleDataToFile();
+ $this->template['msg'] = $this->getLang('vote_deleted');
+ }
+
+ // ---------- HELPER METHODS -----------
+
+ /**
+ * check if the currently logged in user is allowed to edit a given entry
+ * @return true if user is loggedin and in the list of admins or $entryFullname is his own entry
+ */
+ function isAllowedToEditEntry($entryFullname) {
+ global $INFO;
+ global $auth;
+
+ if ($this->params['closed']) return false;
+ if (!$this->isLoggedIn()) return false;
+
+ //check adminGroups
+ if (!empty($this->params['adminGroups'])) {
+ $adminGroups = explode('|', $this->params['adminGroups']); // array of adminGroups
+ $usersGroups = $INFO['userinfo']['grps']; // array of groups that the user is in
+ if (count(array_intersect($adminGroups, $usersGroups)) > 0) return true;
+ }
+
+ //check adminUsers
+ if (!empty($this->params['adminUsers']) &&
+ stripos($this->params['adminUsers'], $_SERVER['REMOTE_USER']) !== false) {
+ return true;
+ }
+
+ //check own entry
+ return strcasecmp(hsc($INFO['userinfo']['name']), $entryFullname) == 0; // compare real name
+ }
+
+ /**
+ * return true if the user is currently logged in
+ */
+ function isLoggedIn() {
+ global $conf;
+ global $auth;
+ return $conf['useacl'] && $auth && $_SERVER['REMOTE_USER'];
+ }
+
+ /**
+ * calculate the input table row:
+ *
+ * May return empty string, if user is not allowed to vote
+ *
+ * If user is logged in he is always allowed edit his own entry. ("change his mind")
+ * If user is logged in and has already voted, empty string will be returned.
+ * If user is not logged in but login is required (auth="user"), then also return '';
+ */
+ function getInputTR() {
+ global $ACT;
+ global $INFO;
+ if ($ACT != 'show') return '';
+ if ($this->params['closed']) return '';
+
+ $fullname = '';
+ $editMode = false;
+ if ($this->isLoggedIn()) {
+ $fullname = $INFO['userinfo']['name'];
+ if (isset($this->template['editEntry'])) {
+ $fullname = $this->template['editEntry']['fullname'];
+ $editMode = true;
+ } else {
+ if (isset($this->doodle["$fullname"]) ) return '';
+ }
+ } else {
+ if ($this->params['auth'] == self::AUTH_USER) return '';
+ }
+
+ // build html for tr
+ $c = count($this->choices);
+ $TR = '';
+ //$TR .= ''.hsc(print_r(func_get_arg(0), true)).''); + } else if (func_num_args() == 2) { + msg('
'.func_get_arg(0).'
'.hsc(print_r(func_get_arg(1), true)).''); + } + +} + +?> Property changes on: web/php-wiki/trunk/dokuwiki/lib/plugins/doodle/syntax.php ___________________________________________________________________ Added: svn:executable + *