moodle-repository_onenote/lib.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/>.

/**
 * Microsoft OneNote Repository Plugin
 * @package    repository_onenote
 * @author Vinayak (Vin) Bhalerao (v-vibhal@microsoft.com)
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @copyright  Microsoft, Inc. (based on files by 2012 Lancaster University Network Services Ltd)
 */

defined('MOODLE_INTERNAL') || die();

/**
 * Microsoft OneNote repository plugin.
 *
 * @package    repository_onenote
 */
class repository_onenote extends repository {
    private $onenoteapi = null;

    /**
     * Constructor
     *
     * @param int $repositoryid repository instance id.
     * @param int|stdClass $context a context id or context object.
     * @param array $options repository options.
     */
    public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {
        parent::__construct($repositoryid, $context, $options);
        try {
            $this->onenoteapi = \local_onenote\api\base::getinstance();
        } catch (\Exception $e) {
            $this->onenoteapi = false;
        }
    }

    /**
     * Checks whether the user is logged in or not.
     *
     * @return bool true when logged in
     */
    public function check_login() {
        return (!empty($this->onenoteapi)) ? $this->onenoteapi->is_logged_in() : false;
    }

    /**
     * Check whether we have API access.
     *
     * @return bool Whether API access is active.
     */
    public function check_api() {
        if (!empty($this->onenoteapi)) {
            if (class_exists('\local_onenote\api\o365') && $this->onenoteapi instanceof \local_onenote\api\o365) {
                if (\local_o365\utils::is_configured() === true) {
                    return true;
                }
            }
            if (class_exists('\local_onenote\api\msaccount') && $this->onenoteapi instanceof \local_onenote\api\msaccount) {
                if (\local_msaccount\client::is_configured() === true) {
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * Print the login form, if required
     *
     * @return array of login options
     */
    public function print_login() {
        if ($this->check_api() !== true) {
            throw new \moodle_exception('errorauthoidcnotconfig', 'repository_onenote');
        }

        $url = $this->onenoteapi->get_login_url();

        if ($this->options['ajax']) {
            $popup = new stdClass();
            $popup->type = 'popup';
            $popup->url = $url->out(false);
            return array('login' => array($popup));
        } else {
            echo '<a target="_blank" href="'.$url->out(false).'">'.get_string('login', 'repository').'</a>';
        }
    }

    /**
     * Given a path, and perhaps a search, get a list of files.
     *
     * See details on {@link http://docs.moodle.org/dev/Repository_plugins}
     *
     * @param string $path identifier for current path
     * @param string $page the page number of file list
     * @return array list of files including meta information as specified by parent.
     */
    public function get_listing($path='', $page = '') {
        if ($this->check_api() !== true) {
            throw new \moodle_exception('errorauthoidcnotconfig', 'repository_onenote');
        }

        $ret = array();
        $ret['dynload'] = true;
        $ret['nosearch'] = true;
        $ret['manage'] = 'https://onenote.com/';

        // Generate path bar, always start with the plugin name.
        $ret['path']   = array();
        $ret['path'][] = array('name' => $this->name, 'path' => '');

        // Get + filter list of files.
        try {
            $fileslist = $this->onenoteapi->get_items_list($path);
        } catch (\Exception $e) {
            // Problem getting an API class.
            $ret['list'] = [];
            return $ret;
        }
        $fileslist = array_filter($fileslist, array($this, 'filter'));
        $ret['list'] = $fileslist;

        // Now add each level folder.
        $trail = '';
        if (!empty($path)) {
            $parts = explode('/', $path);
            foreach ($parts as $folderid) {
                if (!empty($folderid)) {
                    $trail .= ('/'.$folderid);
                    $ret['path'][] = array('name' => $this->onenoteapi->get_item_name($folderid), 'path' => $trail);
                }
            }
        }

        return $ret;
    }

    /**
     * Downloads a repository file and saves to a path.
     *
     * @param string $id identifier of file
     * @param string $filename to save file as
     * @return array with keys:
     *          path: internal location of the file
     *          url: URL to the source
     */
    public function get_file($id, $filename = '') {
        $path = $this->prepare_file($filename);
        return (!empty($this->onenoteapi))
            ? $this->onenoteapi->download_page($id, $path)
            : get_string('error_noapiavailable', 'local_onenote');
    }

    /**
     * Return names of the options to display in the repository form
     *
     * @return array of option names
     */
    public static function get_type_option_names() {
        return array('clientid', 'secret', 'pluginname');
    }

    /**
     * Logout from repository instance and return
     * login form.
     *
     * @return page to display
     */
    public function logout() {
        if (!empty($this->onenoteapi)) {
            $this->onenoteapi->log_out();
        }
        return $this->print_login();
    }

    /**
     * This repository doesn't support global search.
     *
     * @return bool if supports global search
     */
    public function global_search() {
        return false;
    }

    /**
     * This repoistory supports any filetype.
     *
     * @return string '*' means this repository support any files
     */
    public function supported_filetypes() {
        return '*';
    }

    /**
     * This repostiory only supports internal files
     *
     * @return int return type bitmask supported
     */
    public function supported_returntypes() {
        return FILE_INTERNAL;
    }

    /**
     * Validate Admin Settings Moodle form
     *
     * @static
     * @param moodleform $mform Moodle form (passed by reference)
     * @param array $data array of ("fieldname"=>value) of submitted data
     * @param array $errors array of ("fieldname"=>errormessage) of errors
     * @return array array of errors
     */
    public static function type_form_validation($mform, $data, $errors) {
        global $CFG;
        if (\local_o365\utils::is_configured() !== true) {
            array_push($errors, get_string('notconfigured', 'repository_onenote', $CFG->wwwroot));
        }
        return $errors;
    }

    /**
     * Setup repistory form.
     *
     * @param moodleform $mform Moodle form (passed by reference)
     * @param string $classname repository class name
     */
    public static function type_config_form($mform, $classname = 'repository') {
        global $CFG;
        $a = new stdClass;
        if (\local_o365\utils::is_configured() !== true) {
            $mform->addElement('static', null, '', get_string('notconfigured', 'repository_onenote', $CFG->wwwroot));
        }
        parent::type_config_form($mform);
    }
}