Add historical page for institution statistics

Change-Id: Ied0536afa29854fa201fbccbb40ace0ef8f2162c
Signed-off-by: Hugh Davenport <hugh@catalyst.net.nz>

htdocs/admin/users/statistics.json.php

@@ -36,14 +36,21 @@ $extradata = json_decode(param_variable('extradata'));
 $institution = (isset($extradata->institution) ? $extradata->institution : 'mahara');
 
 $type = param_alpha('type', 'users');
-$subpages = array('users', 'views', 'registration');
+$subpages = array('users', 'views', 'registration', 'historical');
 if (!in_array($type, $subpages)) {
     $type = 'users';
 }
 
+if ($type == 'historical') {
+    $field = (isset($extradata->field) ? $extradata->field : 'count_members');
+}
+
 $institutiondata = institution_statistics($institution, true);
 
 switch ($type) {
+case 'historical':
+    $data = institution_historical_stats_table($limit, $offset, $field, $institutiondata);
+    break;
 case 'registration':
     $data = institution_registration_stats_table($limit, $offset, $institutiondata);
     break;

htdocs/admin/users/statistics.php

@@ -60,7 +60,7 @@ $institutionselector = pieform(array(
 define('TITLE', get_string('institutionstatisticsfor', 'admin', get_field('institution', 'displayname', 'name', $institution)));
 
 $type = param_alpha('type', 'users');
-$subpages = array('users', 'views', 'registration');
+$subpages = array('users', 'views', 'registration', 'historical');
 $offset = param_integer('offset', 0);
 $limit  = param_integer('limit', 10);
 
@@ -68,10 +68,16 @@ if (!in_array($type, $subpages)) {
     $type = 'users';
 }
 
+if ($type == 'historical') {
+    $field = param_alphanumext('field', 'count_members');
+}
 
 $institutiondata = institution_statistics($institution, true);
 
 switch ($type) {
+case 'historical':
+    $data = institution_historical_statistics($limit, $offset, $field, $institutiondata);
+    break;
 case 'registration':
     $data = institution_registration_statistics($limit, $offset, $institutiondata);
     break;

htdocs/lang/en.utf8/admin.php

@@ -277,6 +277,7 @@ $string['institutioncreated'] = 'Institution created';
 
 // Registration statistics
 $string['registrationstatstabletitle'] = 'Registration statistics for the current week';
+$string['historicalstatstabletitle'] = 'Historical statistics for field \'%s\'';
 
 // Site options
 $string['adminsonly'] = 'Administrators only';

htdocs/lang/en.utf8/mahara.php

@@ -1038,3 +1038,4 @@ $string['cleanurlallowedcharacters'] = 'Only lowercase letters from a-z, numbers
 // Registration statistics
 $string['registration'] = 'Registration';
 $string['modified'] = 'Modified';
+$string['historical'] = 'Historical';

htdocs/lib/registration.php

@@ -1687,11 +1687,109 @@ function institution_registration_stats_table($limit, $offset, &$institutiondata
     $smarty = smarty_core();
     $smarty->assign('data', $registrationdata);
     $smarty->assign('offset', $offset);
+    $smarty->assign('institution', $institutiondata['name']);
     $result['tablerows'] = $smarty->fetch('admin/registrationstats.tpl');
 
     return $result;
 }
 
+function institution_historical_statistics($limit, $offset, $field, &$institutiondata) {
+    $data = array();
+    $data['tableheadings'] = array(
+        array('name' => get_string('date')),
+        array('name' => get_string('modified'), 'class' => 'center'),
+        array('name' => get_string('Total'), 'class' => 'center'),
+    );
+    $data['table'] = institution_historical_stats_table($limit, $offset, $field, $institutiondata);
+    $data['tabletitle'] = get_string('historicalstatstabletitle', 'admin', get_string($field, 'statistics'));
+
+    $data['summary'] = $data['table']['count'] == 0 ? get_string('nostats', 'admin') : 'FIXME: should something go here?';
+
+    return $data;
+}
+
+function institution_historical_stats_table($limit, $offset, $field, &$institutiondata) {
+    global $USER;
+
+    $count = count_records_sql(
+        "SELECT COUNT(*)
+        FROM {institution_registration} ir
+        JOIN {institution_registration_data} ird
+            ON (ird.registration_id = ir.id)
+        WHERE ir.institution = ? AND ird.field = ?",
+        array($institutiondata['name'], $field)
+    );
+
+    $pagination = build_pagination(array(
+        'id' => 'stats_pagination',
+        'url' => get_config('wwwroot') . 'admin/users/statistics.php?institution=' . $institutiondata['name'] . '&type=historical',
+        'jsonscript' => 'admin/users/statistics.json.php',
+        'datatable' => 'statistics_table',
+        'count' => $count,
+        'limit' => $limit,
+        'offset' => $offset,
+        'extradata' => array('institution' => $institutiondata['name'], 'field' => $field),
+        'setlimit' => true,
+    ));
+
+    $result = array(
+        'count'         => $count,
+        'tablerows'     => '',
+        'pagination'    => $pagination['html'],
+        'pagination_js' => $pagination['javascript'],
+    );
+
+    if ($count < 1) {
+        return $result;
+    }
+
+    $registrationdata = get_records_sql_array(
+        "SELECT
+            ir.id, ir.time, ird.field, ird.value
+        FROM {institution_registration} ir
+        JOIN {institution_registration_data} ird
+            ON (ird.registration_id = ir.id)
+        WHERE ir.institution = ? AND ird.field = ?
+        ORDER BY ir.time DESC",
+        array($institutiondata['name'], $field),
+        $offset,
+        $limit
+    );
+
+    if ($field == 'count_members') {
+        foreach ($registrationdata as &$d) {
+            $d->modified = get_field('institution_registration_data', 'value', 'registration_id', $d->id, 'field', 'usersloggedin');
+        }
+    }
+    else {
+        if ($registrationdata) {
+            $registrationdata[count($registrationdata) - 1]->modified = $registrationdata[count($registrationdata) - 1]->value;
+        }
+        for ($i = count($registrationdata) - 2; $i >= 0; -- $i) {
+            $registrationdata[$i]->modified = $registrationdata[$i]->value - $registrationdata[$i + 1]->value;
+        }
+    }
+
+    $csvfields = array('time', 'field', 'modified', 'value');
+    $csv = join(',', $csvfields) . "\n";
+    foreach ($registrationdata as &$d) {
+        $data = array();
+        foreach ($csvfields as $f) {
+            $data[] = str_replace('"', '""', $d->$f);
+        }
+        $csv .= '"' . join('","', $data) . '"' . "\n";
+    }
+    $USER->set_download_file($csv, 'registrationstatistics.csv', 'text/csv');
+    $result['csv'] = true;
+
+    $smarty = smarty_core();
+    $smarty->assign('data', $registrationdata);
+    $smarty->assign('offset', $offset);
+    $result['tablerows'] = $smarty->fetch('admin/historicalstats.tpl');
+
+    return $result;
+}
+
 
 function graph_site_data_weekly() {
 

htdocs/theme/raw/templates/admin/historicalstats.tpl

+{foreach from=$data item=item key=key}
+  <tr class="{cycle values='r0,r1'}">
+    <td>{$item->time}</td>
+    <td class="center">{$item->modified}</td>
+    <td class="center">{$item->value}</td>
+  </tr>
+{/foreach}
+