5d4a98014547d6dcc9173a31f29671a706f12580
[moodle.git] / report / log / graph.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Produces a graph of log accesses for a user
19  *
20  * @package    report
21  * @subpackage log
22  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require("../../config.php");
27 require_once("$CFG->libdir/graphlib.php");
28 require_once($CFG->dirroot.'/report/log/locallib.php');
30 $id   = required_param('id', PARAM_INT);       // Course ID
31 $type = required_param('type', PARAM_FILE);    // Graph Type
32 $user = required_param('user', PARAM_INT);     // Student ID
33 $date = optional_param('date', 0, PARAM_INT);  // A time of a day (in GMT)
35 $url = new moodle_url('/report/log/graph.php', array('id'=>$id,'type'=>$type,'user'=>$user,'date'=>$date));
36 $PAGE->set_url($url);
38 if ($type !== "usercourse.png" and $type !== "userday.png") {
39     $type = 'userday.png';
40 }
42 $course = $DB->get_record("course", array("id"=>$id), '*', MUST_EXIST);
43 $user = $DB->get_record("user", array("id"=>$user, 'deleted'=>0), '*', MUST_EXIST);
45 $coursecontext   = context_course::instance($course->id);
46 $personalcontext = context_user::instance($user->id);
48 if ($USER->id != $user->id and has_capability('moodle/user:viewuseractivitiesreport', $personalcontext)
49         and !is_enrolled($coursecontext, $USER) and is_enrolled($coursecontext, $user)) {
50     //TODO: do not require parents to be enrolled in courses - this is a hack!
51     require_login();
52     $PAGE->set_course($course);
53 } else {
54     require_login($course);
55 }
57 list($all, $today) = report_log_can_access_user_report($user, $course);
59 if ($type === "userday.png") {
60     if (!$today) {
61         require_capability('report/log:viewtoday', $coursecontext);
62     }
63 } else {
64     if (!$all) {
65         require_capability('report/log:view', $coursecontext);
66     }
67 }
69 add_to_log($course->id, 'course', 'report log', "report/log/graph.php?user=$user->id&id=$course->id&type=$type&date=$date", $course->id);
71 $logs = array();
73 $timenow = time();
75 if ($type === "usercourse.png") {
77    $site = get_site();
79    if ($course->id == $site->id) {
80        $courseselect = 0;
81    } else {
82        $courseselect = $course->id;
83    }
85    $maxseconds = REPORT_LOG_MAX_DISPLAY * 3600 * 24;  // seconds
86    //$maxseconds = 60 * 3600 * 24;  // seconds
87    if ($timenow - $course->startdate > $maxseconds) {
88        $course->startdate = $timenow - $maxseconds;
89    }
91    if (!empty($CFG->loglifetime)) {
92        $maxseconds = $CFG->loglifetime * 3600 * 24;  // seconds
93        if ($timenow - $course->startdate > $maxseconds) {
94            $course->startdate = $timenow - $maxseconds;
95        }
96    }
98    $timestart = $coursestart = usergetmidnight($course->startdate);
100    if ((($timenow - $timestart)/86400.0) > 40) {
101        $reducedays = 7;
102    } else {
103        $reducedays = 0;
104    }
106    $days = array();
107    $i = 0;
108    while ($timestart < $timenow) {
109        $timefinish = $timestart + 86400;
110        if ($reducedays) {
111            if ($i % $reducedays) {
112                $days[$i] = "";
113            } else {
114                $days[$i] = userdate($timestart, "%a %d %b");
115            }
116        } else {
117            $days[$i] = userdate($timestart, "%a %d %b");
118        }
119        $logs[$i] = 0;
120        $i++;
121        $timestart = $timefinish;
122    }
124    if ($rawlogs = get_logs_usercourse($user->id, $courseselect, $coursestart)) {
125        foreach ($rawlogs as $rawlog) {
126            $logs[$rawlog->day] = $rawlog->num;
127        }
128    }
130    $graph = new graph(750, 400);
132    $a->coursename = format_string($course->shortname, true, array('context' => $coursecontext));
133    $a->username = fullname($user, true);
134    $graph->parameter['title'] = get_string("hitsoncourse", "", $a);
136    $graph->x_data           = $days;
138    $graph->y_data['logs']   = $logs;
139    $graph->y_order = array('logs');
141    if (!empty($CFG->preferlinegraphs)) {
142        $graph->y_format['logs'] = array('colour' => 'blue','line' => 'line');
143    } else {
144        $graph->y_format['logs'] = array('colour' => 'blue','bar' => 'fill','bar_size' => 0.6);
145        $graph->parameter['bar_spacing'] = 0;
146    }
149    $graph->parameter['y_label_left']     = get_string("hits");
150    $graph->parameter['label_size']       = "12";
151    $graph->parameter['x_axis_angle']     = 90;
152    $graph->parameter['x_label_angle']    = 0;
153    $graph->parameter['tick_length'] = 0;
156    $graph->parameter['shadow']          = 'none';
158    error_reporting(5); // ignore most warnings such as font problems etc
159    $graph->draw_stack();
161 } else {
163    $site = get_site();
165    if ($course->id == $site->id) {
166        $courseselect = 0;
167    } else {
168        $courseselect = $course->id;
169    }
171    if ($date) {
172        $daystart = usergetmidnight($date);
173    } else {
174        $daystart = usergetmidnight(time());
175    }
176    $dayfinish = $daystart + 86400;
178    $hours = array();
179    for ($i=0; $i<=23; $i++) {
180        $logs[$i] = 0;
181        $hour = $daystart + $i * 3600;
182        $hours[$i] = $i;
183    }
185    if ($rawlogs = get_logs_userday($user->id, $courseselect, $daystart)) {
186        foreach ($rawlogs as $rawlog) {
187            $logs[$rawlog->hour] = $rawlog->num;
188        }
189    }
191    $graph = new graph(750, 400);
193    $a->coursename = format_string($course->shortname, true, array('context' => $coursecontext));
194    $a->username = fullname($user, true);
195    $graph->parameter['title'] = get_string("hitsoncoursetoday", "", $a);
197    $graph->x_data           = $hours;
199    $graph->y_data['logs']   = $logs;
200    $graph->y_order = array('logs');
202    if (!empty($CFG->preferlinegraphs)) {
203        $graph->y_format['logs'] = array('colour' => 'blue','line' => 'line');
204    } else {
205        $graph->y_format['logs'] = array('colour' => 'blue','bar' => 'fill','bar_size' => 0.9);
206    }
208    $graph->parameter['y_label_left']     = get_string("hits");
209    $graph->parameter['label_size']       = "12";
210    $graph->parameter['x_axis_angle']     = 0;
211    $graph->parameter['x_label_angle']    = 0;
213    $graph->parameter['shadow']          = 'none';
215    error_reporting(5); // ignore most warnings such as font problems etc
216    $graph->draw_stack();