block_configurable_reports.php

<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle 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.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/** Configurable Reports
  * A Moodle block for creating customizable reports
  * @package blocks
  * @author: Juan leyva <http://www.twitter.com/jleyvadelgado>
  * @date: 2009
  */

class block_configurable_reports extends block_list {

    /**
     * Sets the block name and version number
     *
     * @return void
     **/
    public function init() {
        $this->title = get_string('pluginname', 'block_configurable_reports');
    }

    /**
     * Where to add the block
     *
     * @return boolean
     **/
    public function applicable_formats() {
        return array('site' => true, 'course' => true, 'my' => true);
    }

    /**
     * Global Config?
     *
     * @return boolean
     **/
    public function has_config() {
        return true;
    }

    /**
     * More than one instance per page?
     *
     * @return boolean
     **/
    public function instance_allow_multiple() {
      return false;
    }

    /**
     * Gets the contents of the block (course view)
     *
     * @return object An object with the contents
     **/
    public function get_content() {
        global $DB, $USER, $CFG ,$COURSE;

        if($this->content !== NULL) {
            return $this->content;
        }

		$this->content = new stdClass;
		$this->content->footer = '';
		$this->content->icons = array();

		if (!isloggedin())
			return $this->content;

		require_once($CFG->dirroot."/blocks/configurable_reports/locallib.php");

		$course = $DB->get_record('course',array('id' => $COURSE->id));

		if(!$course)
			print_error('coursedoesnotexists');

		if ($course->id == SITEID) {
            $context = context_system::instance();
        } else {
            $context = context_course::instance($course->id);
        }

        // Site (Shared) reports
        $reports = $DB->get_records('block_configurable_reports',array('courseid' => SITEID),'name ASC');

        if ($reports) {
            foreach($reports as $report){
                if($report->visible && !$report->subreport && cr_check_report_permissions($report, $USER->id, $context)){
                    $rname = format_string($report->name);
                    $this->content->items[] = '<a href= "'.$CFG->wwwroot.'/blocks/configurable_reports/viewreport.php?id='.$report->id.'&courseid='.$course->id.'" alt="'.$rname.'">'.$rname.'</a>';
                }
            }
            if (count($reports))
                $this->content->items[] = '========';
        }

        // Course reports
        if ($course->id != SITEID) {
            $reports = $DB->get_records('block_configurable_reports',array('courseid' => $course->id),'name ASC');

            if ($reports) {
                foreach($reports as $report) {
                    if($report->visible && !$report->subreport && cr_check_report_permissions($report,$USER->id,$context)){
                        $rname = format_string($report->name);
                        $this->content->items[] = '<a href= "'.$CFG->wwwroot.'/blocks/configurable_reports/viewreport.php?id='.$report->id.'&courseid='.$course->id.'" alt="'.$rname.'">'.$rname.'</a>';
                    }
                }
                if (count($reports))
                    $this->content->items[] = '========';
            }
        }

		if(has_capability('block/configurable_reports:managereports', $context) || has_capability('block/configurable_reports:manageownreports', $context)){
			$this->content->items[] = '<a href="'.$CFG->wwwroot.'/blocks/configurable_reports/managereport.php?courseid='.$course->id.'">'.(get_string('managereports','block_configurable_reports')).'</a>';
		}

        return $this->content;
    }
    /*
     * Moved to classes/task/schedualed_queries.php
     * todo: remove this code
     *
        public function cron() {

            global $CFG, $DB;

            $hour = get_config('block_configurable_reports','cron_hour');
            $min = get_config('block_configurable_reports','cron_minute');

            $date = usergetdate(time());
            $usertime = mktime($date['hours'], $date['minutes'], $date['seconds'], $date['mon'], $date['mday'], $date['year']);

            $crontime = mktime($hour, $min, $date['seconds'], $date['mon'], $date['mday'], $date['year']);

            if ( ($crontime - $usertime) < 0 ) return false;

            $lastcron = $DB->get_field('blocks', 'lastcron', array('name' => 'configurable_reports'));
            if (!$lastcron and ($lastcron + $this->cron < time()) ) return false;

            // Starting to run...
            //$DB->set_field('blocks','lastcron',time(), array('name' => 'configurable_reports'));

            require_once($CFG->dirroot."/blocks/configurable_reports/locallib.php");
            require_once($CFG->dirroot.'/blocks/configurable_reports/report.class.php');
            require_once($CFG->dirroot.'/blocks/configurable_reports/reports/sql/report.class.php');

            //mtrace("\nConfigurable report (block)");

            $reports = $DB->get_records('block_configurable_reports');
            if ($reports) {
                foreach ($reports as $report) {
                    // Running only SQL reports. $report->type == 'sql'
                    if ($report->type == 'sql' AND (!empty($report->cron) AND $report->cron == '1')) {
                        $reportclass = new report_sql($report);

                        // Execute it using $remoteDB
                        $starttime = microtime(true);
                        mtrace("\nExecuting query '$report->name'");
                        //$results = $reportclass->create_report();
                        $components = cr_unserialize($reportclass->config->components);
                        $config = (isset($components['customsql']['config']))? $components['customsql']['config'] : new stdclass;
                        $sql = $reportclass->prepare_sql($config->querysql);
                        //if (strpos($sql, ';') !== false) {
                            $sqlqueries = explode(';',$sql);
                        //} else
                        foreach ($sqlqueries as $sql) {
                            mtrace(substr($sql,0,60)); // Show some SQL
                            $results = $reportclass->execute_query($sql);
                            mtrace(($results==1) ? '...OK time='.round((microtime(true) - $starttime) * 1000).'mSec' : 'Some SQL Error'.'\n');
                        }
                        unset($reportclass);
                    }
                }
            }
            return true; // Finished OK.
        }
        */

}