lib/classes/requirejs.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/>.
  16
  17 /**
  18  * RequireJS helper functions.
  19  *
  20  * @package    core
  21  * @copyright  2015 Damyon Wiese <damyon@moodle.com>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 defined('MOODLE_INTERNAL') || die();
  26
  27 /**
  28  * Collection of requirejs related methods.
  29  *
  30  * @copyright  2015 Damyon Wiese <damyon@moodle.com>
  31  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  32  */
  33 class core_requirejs {
  34
  35     /**
  36      * Check a single module exists and return the full path to it.
  37      *
  38      * The expected location for amd modules is:
  39      *  <componentdir>/amd/src/modulename.js
  40      *
  41      * @param string $component The component determines the folder the js file should be in.
  42      * @param string $jsfilename The filename for the module (with the js extension).
  43      * @param bool $unused
  44      * @return array $files An array of mappings from module names to file paths.
  45      *                      Empty array if the file does not exist.
  46      */
  47     public static function find_one_amd_module($component, $jsfilename, $unused = false) {
  48         $jsfileroot = core_component::get_component_directory($component);
  49         if (!$jsfileroot) {
  50             return array();
  51         }
  52
  53         $module = str_replace('.js', '', $jsfilename);
  54
  55         $srcdir = $jsfileroot . '/amd/build';
  56         $minpart = '.min';
  57
  58         $filename = $srcdir . '/' . $module . $minpart . '.js';
  59         if (!file_exists($filename)) {
  60             return array();
  61         }
  62
  63         $fullmodulename = $component . '/' . $module;
  64         return array($fullmodulename => $filename);
  65     }
  66
  67     /**
  68      * Scan the source for AMD modules and return them all.
  69      *
  70      * The expected location for amd modules is:
  71      *  <componentdir>/amd/src/modulename.js
  72      *
  73      * @param boolean $unused
  74      * @param boolean $includelazy If true, includes modules with the -lazy suffix.
  75      * @return array $files An array of mappings from module names to file paths.
  76      */
  77     public static function find_all_amd_modules($unused = false, $includelazy = false) {
  78         global $CFG;
  79
  80         $jsdirs = array();
  81         $jsfiles = array();
  82
  83         $dir = $CFG->libdir . '/amd';
  84         if (!empty($dir) && is_dir($dir)) {
  85             $jsdirs['core'] = $dir;
  86         }
  87         $subsystems = core_component::get_core_subsystems();
  88         foreach ($subsystems as $subsystem => $dir) {
  89             if (!empty($dir) && is_dir($dir . '/amd')) {
  90                 $jsdirs['core_' . $subsystem] = $dir . '/amd';
  91             }
  92         }
  93         $plugintypes = core_component::get_plugin_types();
  94         foreach ($plugintypes as $type => $dir) {
  95             $plugins = core_component::get_plugin_list_with_file($type, 'amd', false);
  96             foreach ($plugins as $plugin => $dir) {
  97                 if (!empty($dir) && is_dir($dir)) {
  98                     $jsdirs[$type . '_' . $plugin] = $dir;
  99                 }
 100             }
 101         }
 102
 103         foreach ($jsdirs as $component => $dir) {
 104             $srcdir = $dir . '/build';
 105             if (!is_dir($srcdir) || !is_readable($srcdir)) {
 106                 // This is probably an empty amd directory without src or build.
 107                 // Skip it - RecursiveDirectoryIterator fatals if the directory is not readable as an iterator.
 108                 continue;
 109             }
 110             $srcdir = realpath($srcdir);
 111             $directory = new RecursiveDirectoryIterator($srcdir);
 112             $items = new RecursiveIteratorIterator($directory);
 113             foreach ($items as $item) {
 114                 $extension = $item->getExtension();
 115                 if ($extension === 'js') {
 116                     $filename = substr($item->getRealpath(), strlen($srcdir) + 1);
 117                     $filename = preg_replace('/(\.min)?\.js$/', '', $filename);
 118                     // We skip lazy loaded modules unless specifically requested.
 119                     if ($includelazy || strpos($filename, '-lazy') === false) {
 120                         $modulename = $component . '/' . $filename;
 121                         $jsfiles[$modulename] = $item->getRealPath();
 122                     }
 123                 }
 124                 unset($item);
 125             }
 126             unset($items);
 127         }
 128
 129         return $jsfiles;
 130     }
 131
 132 }