<?php if (!defined('PmWiki')) exit();
# vim: set ts=4 sw=4 et:
##
##        File: votecounter.php
##     Version: 2010-01-31
##      SVN ID: $Id: votecounter.php 322 2009-03-10 06:52:44Z pbowers $
##      Status: alpha
##      Author: Peter Bowers
## Create Date: March 8, 2009
##   Copyright: 2009, Peter Bowers
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License, Version 2, as
## published by the Free Software Foundation.
## http://www.gnu.org/copyleft/gpl.html
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##

$RecipeInfo['VoteCounter']['Version'] = '2010-01-31';

/****************
 Given lines matching this pattern:
   * (rate-text) comment-text
   -or-
   # (rate-text) comment-text
 (rate-text is arbitrary but a leading + or - is significant for sums)
 (comment-text is arbitrary and ignored)
 ****************/

# A summary containing "$VoteCount: $VoteDetail" (see below)
$FmtPV['$Votes']           = 'VoteCounter($pagename, $pn, "Votes")';
# A simple count of all lines containing a valid vote
$FmtPV['$VoteCount']       = 'VoteCounter($pagename, $pn, "VoteCount")';
# A summary of how many times each rate-text occurred
$FmtPV['$VoteDetail']      = 'VoteCounter($pagename, $pn, "VoteDetail")';
$FmtPV['$VoteDetails']      = 'VoteCounter($pagename, $pn, "VoteDetail")';
# The sum of all + votes minus all - votes, ++ or -- or +2 all count as 1
$FmtPV['$VoteSum']         = 'VoteCounter($pagename, $pn, "VoteSum")';
# The sum of all + votes minus all - votes, ++ or -- or +2 count double
$FmtPV['$VoteWeightedSum'] = 'VoteCounter($pagename, $pn, "VoteWeightedSum")';

Markup('votecounter', '>{$var}', '/\(:votecounter\s(.*?):\)/ie', 
    'VoteCounter(\$pagename, \$pagename, "$1")');
function VoteCounter($pagename, $pn, $args)
{
    global $vcDetailFmt, $vcDetailSep, $vcMaxWeight;
    SDV($vcMaxWeight, 4); // don't allow more than ++++, ----, +4, or -4
    SDV($vcDetailFmt, '{RATETEXT}({COUNT})');
    SDV($vcDetailSep, ', ');
    $opt = ParseArgs($args);
    if ($opt['page']) $pn = $opt['page'];
    $maxweight = (@$opt['maxweight'] ? $opt['maxweight'] : $vcMaxWeight);
    if (!$pn) $pn = $pagename;
    if (!$opt['']) $opt[''][] = 'votes';
    if ($opt['detailfmt']) $DetailFmt = $opt['detailfmt'];
    else $DetailFmt = $vcDetailFmt;
    if ($opt['detailsep']) $DetailSep = $opt['detailsep'];
    else $DetailSep = $vcDetailSep;
    if (defined('toolbox')) {
        $page = tbRetrieveAuthPage($pagename, $pn, 'read');
        $page['text'] = $page['ntext'];
    } else {
        $pn = MakePageName($pagename, $pn);
        $page = RetrieveAuthPage($pn, 'read');
    }
    if (preg_match_all('/^\s*[*#]+\s*\(([^)]*)\)/m', $page['text'], $matches, PREG_SET_ORDER)) {
        foreach ($matches as $m)
            $votes[strtolower($m[1])]++;
        # Calculate $detail
        $detail = '';
        foreach ($votes as $k => $v) {
            $detail .= ($detail?$DetailSep:'').
                str_replace(array('{RATETEXT}', '{COUNT}'), array($k, $v), $DetailFmt);
        }
        # Calculate Sum
        $sum = 0;
        foreach ($votes as $k => $v) {
            if ($k{0} == '+')
                $sum += $v;
            elseif ($k{0} == '-')
                $sum -= $v;
        }
        # Calculate weighted sum
        $wsum = 0;
        foreach ($votes as $k => $v) {
            if (preg_match('/([+-])((\1+)|(\d*))/', $k, $m)) {
                if (!$m[2]) $i = 1;                  // (+) or (-)
                elseif ($m[3]) $i = strlen($m[3])+1; // (++) or (--)
                else $i = $m[4];                     // (+2) or (-2)
                if ($i > $maxweight) $i = $maxweight;
                if ($m[1] == '+')
                    $wsum += $v*$i;
                else
                    $wsum -= $v*$i;
            }
        }
        # Calculate votecount
        $count = count($matches);
    } else {
        $count = $sum = $wsum = 0;
        $detail = '(none)';
    }
    $rtn = '';
    foreach ($opt[''] as $mode) {
        $mode = strtolower($mode);
        if ($rtn && !preg_match('/[:,]\s*$/', $rtn)) $rtn .= ', ';
        switch ($mode) {
        case 'votes':
            $rtn .= "$count: $detail";
            break;
        case 'votecount':
            $rtn .= $count;
            break;
        case 'votedetail':
        case 'votedetails':
            $rtn .= $detail;
            break;
        case 'votesum':
            $rtn .= $sum;
            break;
        case 'voteweightedsum':
            $rtn .= $wsum;
            break;
        default:
            $rtn .= $mode;
            break;
        }
    }
    return($rtn);
}