b7f18bc0a69a0a46882a0b6cfe54ad066dddd445
[moodle.git] / admin / tool / installaddon / classes / installer.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Provides tool_installaddon_installer class
20  *
21  * @package     tool_installaddon
22  * @subpackage  classes
23  * @copyright   2013 David Mudrak <david@moodle.com>
24  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Implements main plugin features.
31  *
32  * @copyright 2013 David Mudrak <david@moodle.com>
33  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class tool_installaddon_installer {
37     /** @var tool_installaddon_installfromzip */
38     protected $installfromzipform = null;
40     /**
41      * Factory method returning an instance of this class.
42      *
43      * @return tool_installaddon_installer
44      */
45     public static function instance() {
46         return new self();
47     }
49     /**
50      * Returns URL to the repository that addons can be searched in and installed from
51      *
52      * @return moodle_url
53      */
54     public function get_addons_repository_url() {
55         global $CFG;
57         if (!empty($CFG->config_php_settings['alternativeaddonsrepositoryurl'])) {
58             $url = $CFG->config_php_settings['alternativeaddonsrepositoryurl'];
59         } else {
60             $url = 'https://moodle.org/plugins/get.php';
61         }
63         if (!$this->should_send_site_info()) {
64             return new moodle_url($url);
65         }
67         // Append the basic information about our site.
68         $site = array(
69             'fullname' => $this->get_site_fullname(),
70             'url' => $this->get_site_url(),
71             'major_version' => $this->get_site_major_version(),
72         );
74         $site = $this->encode_site_information($site);
76         return new moodle_url($url, array('site' => $site));
77     }
79     /**
80      * @return tool_installaddon_installfromzip
81      */
82     public function get_installfromzip_form() {
83         global $CFG;
84         require_once(dirname(__FILE__).'/installfromzip_form.php');
86         if (!is_null($this->installfromzipform)) {
87             return $this->installfromzipform;
88         }
90         $action = new moodle_url('/admin/tool/installaddon/index.php');
91         $customdata = array('installer' => $this);
93         $this->installfromzipform = new tool_installaddon_installfromzip($action, $customdata);
95         return $this->installfromzipform;
96     }
98     /**
99      * Saves the ZIP file from the {@link tool_installaddon_installfromzip} form
100      *
101      * The file is saved into the given temporary location for inspection and eventual
102      * deployment. The form is expected to be submitted and validated.
103      *
104      * @param tool_installaddon_installfromzip $form
105      * @param string $targetdir full path to the directory where the ZIP should be stored to
106      * @return string filename of the saved file relative to the given target
107      */
108     public function save_installfromzip_file(tool_installaddon_installfromzip $form, $targetdir) {
110         $filename = clean_param($form->get_new_filename('zipfile'), PARAM_FILE);
111         $form->save_file('zipfile', $targetdir.'/'.$filename);
113         return $filename;
114     }
116     /**
117      * Returns localised list of available plugin types
118      *
119      * @return array (string)plugintype => (string)plugin name
120      */
121     public function get_plugin_types_menu() {
122         global $CFG;
123         require_once($CFG->libdir.'/pluginlib.php');
125         $pluginman = plugin_manager::instance();
127         $menu = array('' => get_string('choosedots'));
128         foreach (array_keys($pluginman->get_plugin_types()) as $plugintype) {
129             $menu[$plugintype] = $pluginman->plugintype_name($plugintype).' ('.$plugintype.')';
130         }
132         return $menu;
133     }
135     /**
136      * Returns the full path of the root of the given plugin type
137      *
138      * Null is returned if the plugin type is not known. False is returned if the plugin type
139      * root is expected but not found. Otherwise, string is returned.
140      *
141      * @param string $plugintype
142      * @return string|bool|null
143      */
144     public function get_plugintype_root($plugintype) {
146         $plugintypepath = null;
147         foreach (get_plugin_types() as $type => $fullpath) {
148             if ($type === $plugintype) {
149                 $plugintypepath = $fullpath;
150                 break;
151             }
152         }
153         if (is_null($plugintypepath)) {
154             return null;
155         }
157         if (!is_dir($plugintypepath)) {
158             return false;
159         }
161         return $plugintypepath;
162     }
164     /**
165      * Is it possible to create a new plugin directory for the given plugin type?
166      *
167      * @throws coding_exception for invalid plugin types or non-existing plugin type locations
168      * @param string $plugintype
169      * @return boolean
170      */
171     public function is_plugintype_writable($plugintype) {
173         $plugintypepath = $this->get_plugintype_root($plugintype);
175         if (is_null($plugintypepath)) {
176             throw new coding_exception('Unknown plugin type!');
177         }
179         if ($plugintypepath === false) {
180             throw new coding_exception('Plugin type location does not exist!');
181         }
183         return is_writable($plugintypepath);
184     }
186     //// End of external API ///////////////////////////////////////////////////
188     /**
189      * @return string this site full name
190      */
191     protected function get_site_fullname() {
192         global $SITE;
194         return $SITE->fullname;
195     }
197     /**
198      * @return string this site URL
199      */
200     protected function get_site_url() {
201         global $CFG;
203         return $CFG->wwwroot;
204     }
206     /**
207      * @return string major version like 2.5, 2.6 etc.
208      */
209     protected function get_site_major_version() {
210         return moodle_major_version();
211     }
213     /**
214      * Encodes the given array in a way that can be safely appended as HTTP GET param
215      *
216      * Be ware! The recipient may rely on the exact way how the site information is encoded.
217      * Do not change anything here unless you know what you are doing and understand all
218      * consequences! (Don't you love warnings like that, too? :-p)
219      *
220      * @param array $info
221      * @return string
222      */
223     protected function encode_site_information(array $info) {
224         return base64_encode(json_encode($info));
225     }
227     /**
228      * Decide if the encoded site information should be sent to the add-ons repository site
229      *
230      * For now, we just return true. In the future, we may want to implement some
231      * privacy aware logic (based on site/user preferences for example).
232      *
233      * @return bool
234      */
235     protected function should_send_site_info() {
236         return true;
237     }