externallib.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/>.

/**
 * External Web Service Template
 *
 * @package    block_gps
 * @copyright  2018 Digital Education Society (http://www.dibig.at)
 * @author     Robert Schrenk
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
defined('MOODLE_INTERNAL') || die;
require_once($CFG->libdir . "/externallib.php");

class block_gps_ws extends \core_external\external_api {
    /**
     * Get the banner to be shown on top of the course page.
     **/
    public static function getbanner_parameters() {
        return new external_function_parameters(
            array(
                'courseid' => new external_value(PARAM_INT, 'Course ID'),
            )
        );
    }
    public static function getbanner($courseid) {
        global $CFG, $COURSE, $OUTPUT, $PAGE;
        $params = self::validate_parameters(
            self::getbanner_parameters(),
            array(
                'courseid' => $courseid
            )
        );
        $PAGE->set_context(\context_course::instance($params['courseid']));
        return $OUTPUT->render_from_template('block_gps/injectbanner', (object)array(
            'altitude' => round(\block_gps\locallib::get_location('altitude'), 0),
            'courseid' => $params['courseid'],
            'is_https' => \block_gps\locallib::is_https(),
            'latitude' => \block_gps\locallib::get_location('latitude'),
            'longitude' => \block_gps\locallib::get_location('longitude'),
            'setinterval' => \block_gps\locallib::cache_get('session', 'setinterval'),
            'wwwroot' => $CFG->wwwroot,
        ));
    }
    public static function getbanner_returns() {
        return new external_value(PARAM_RAW, 'The whole banner as HTML Element');
    }
    /**
     * Get honeypots for a user in a specific course.
     * @return checked parameters
     **/
    public static function gethoneypots_parameters() {
        return new external_function_parameters(
                array(
                    'courseid' => new external_value(PARAM_INT, 'Course ID'),
                )
        );
    }
    public static function gethoneypots($courseid) {
        global $PAGE;
        $params = self::validate_parameters(
            self::gethoneypots_parameters(),
            array(
                'courseid' => $courseid
            )
        );

        $PAGE->set_context(\context_course::instance($params['courseid']));
        $honeypots = \block_gps\locallib::get_honeypots($params['courseid']);

        return json_encode($honeypots, JSON_NUMERIC_CHECK);
    }
    public static function gethoneypots_returns() {
        return new external_value(PARAM_RAW, 'All honeypots as JSON-String');
    }
    /**
     * Store current location to session
     * @return checked parameters
     **/
    public static function locate_parameters() {
        return new external_function_parameters(
                array(
                    'lat' => new external_value(PARAM_FLOAT, 'Latitude', VALUE_DEFAULT, -200),
                    'lon' => new external_value(PARAM_FLOAT, 'Longitude', VALUE_DEFAULT, -200),
                    'alt' => new external_value(PARAM_FLOAT, 'Altitude', VALUE_DEFAULT, 0),
                )
        );
    }
    public static function locate($lat, $lon, $alt) {
        $params = self::validate_parameters(
            self::locate_parameters(),
            array(
                'lat' => $lat,
                'lon' => $lon,
                'alt' => $alt
            )
        );

        if (empty(\block_gps\locallib::get_location('latitude'))) {
            $position1 = array(
                'longitude' => 0,
                'latitude' => 0,
            );
        } else {
            $position1 = array(
                'longitude' => \block_gps\locallib::get_location('longitude'),
                'latitude' => \block_gps\locallib::get_location('latitude'),
            );
        }

        $position2 = array(
            'longitude' => $params['lon'],
            'latitude' => $params['lat'],
        );

        $distance = \block_gps\locallib::get_distance(
            (object)$position1,
            (object)$position2,
            0
        );

        if ($distance > 5 && $params['lat'] > -200 && $params['lon'] > -200) {
            \block_gps\locallib::set_location($params['lat'], $params['lon'], $params['alt']);
            return 'coordinates_set';
        } else {
            if ($distance < 5) {
                return 'moved_less_than_5m';
            } else {
                return 'invalid_coordinates';
            }
        }
    }
    public static function locate_returns() {
        return new external_value(PARAM_TEXT, 'Error-Messages if occured');
    }

    /**
     * Store the desired interval.
     * @return checked parameters
     **/
    public static function setinterval_parameters() {
        return new external_function_parameters(
            array(
                'ms' => new external_value(PARAM_INT, 'Milliseconds'),
            )
        );
    }
    public static function setinterval($ms) {
        global $CFG;
        $params = self::validate_parameters(
            self::setinterval_parameters(),
            array(
                'ms' => $ms
            )
        );
        \block_gps\locallib::cache_set('session', 'setinterval', $params['ms']);
        return 'ok';
    }
    public static function setinterval_returns() {
        return new external_value(PARAM_TEXT, 'Error-Messages if occured');
    }
}