From 0d435a3d7c668772aa2851407fd4a30ea9d490fd Mon Sep 17 00:00:00 2001
From: Dan Poltawski <dan@moodle.com>
Date: Fri, 23 Aug 2013 10:38:02 +0800
Subject: [PATCH] MDL-33472 google plugins: move helper functions to
 upgradelib.php

upgrade.php is reserved for the upgrade steps only. See also
MDL-34103
---
 portfolio/googledocs/db/upgrade.php     | 26 +-----------
 portfolio/googledocs/db/upgradelib.php  | 53 +++++++++++++++++++++++++
 portfolio/picasa/db/upgrade.php         | 26 +-----------
 portfolio/picasa/db/upgradelib.php      | 53 +++++++++++++++++++++++++
 repository/googledocs/db/upgrade.php    | 26 +-----------
 repository/googledocs/db/upgradelib.php | 53 +++++++++++++++++++++++++
 repository/picasa/db/upgrade.php        | 26 +-----------
 repository/picasa/db/upgradelib.php     | 53 +++++++++++++++++++++++++
 8 files changed, 216 insertions(+), 100 deletions(-)
 create mode 100644 portfolio/googledocs/db/upgradelib.php
 create mode 100644 portfolio/picasa/db/upgradelib.php
 create mode 100644 repository/googledocs/db/upgradelib.php
 create mode 100644 repository/picasa/db/upgradelib.php

diff --git a/portfolio/googledocs/db/upgrade.php b/portfolio/googledocs/db/upgrade.php
index 8a333e67cdb..086102bf685 100644
--- a/portfolio/googledocs/db/upgrade.php
+++ b/portfolio/googledocs/db/upgrade.php
@@ -20,6 +20,7 @@
  */
 function xmldb_portfolio_googledocs_upgrade($oldversion) {
     global $CFG, $DB;
+    require_once(__DIR__.'/upgradelib.php');
 
     $dbman = $DB->get_manager();
 
@@ -49,28 +50,3 @@ function xmldb_portfolio_googledocs_upgrade($oldversion) {
 
     return true;
 }
-
-function portfolio_googledocs_admin_upgrade_notification() {
-    $admins = get_admins();
-
-    if (empty($admins)) {
-        return;
-    }
-    $a = new stdClass;
-    $a->docsurl = get_docs_url('Google_OAuth_2.0_setup');
-
-    foreach ($admins as $admin) {
-        $message = new stdClass();
-        $message->component         = 'moodle';
-        $message->name              = 'notices';
-        $message->userfrom          = get_admin();
-        $message->userto            = $admin;
-        $message->smallmessage      = get_string('oauth2upgrade_message_small', 'portfolio_googledocs');
-        $message->subject           = get_string('oauth2upgrade_message_subject', 'portfolio_googledocs');
-        $message->fullmessage       = get_string('oauth2upgrade_message_content', 'portfolio_googledocs', $a);
-        $message->fullmessagehtml   = get_string('oauth2upgrade_message_content', 'portfolio_googledocs', $a);
-        $message->fullmessageformat = FORMAT_PLAIN;
-        $message->notification      = 1;
-        message_send($message);
-    }
-}
diff --git a/portfolio/googledocs/db/upgradelib.php b/portfolio/googledocs/db/upgradelib.php
new file mode 100644
index 00000000000..4658ed8deb5
--- /dev/null
+++ b/portfolio/googledocs/db/upgradelib.php
@@ -0,0 +1,53 @@
+<?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/>.
+
+/**
+ * Googledocs portfolio upgrade script.
+ *
+ * @package   portfolio_googledocs
+ * @copyright 2013 Dan Poltawski <dan@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Inform admins about setup required for googledocs change.
+ */
+function portfolio_googledocs_admin_upgrade_notification() {
+    $admins = get_admins();
+
+    if (empty($admins)) {
+        return;
+    }
+    $a = new stdClass;
+    $a->docsurl = get_docs_url('Google_OAuth_2.0_setup');
+
+    foreach ($admins as $admin) {
+        $message = new stdClass();
+        $message->component         = 'moodle';
+        $message->name              = 'notices';
+        $message->userfrom          = get_admin();
+        $message->userto            = $admin;
+        $message->smallmessage      = get_string('oauth2upgrade_message_small', 'portfolio_googledocs');
+        $message->subject           = get_string('oauth2upgrade_message_subject', 'portfolio_googledocs');
+        $message->fullmessage       = get_string('oauth2upgrade_message_content', 'portfolio_googledocs', $a);
+        $message->fullmessagehtml   = get_string('oauth2upgrade_message_content', 'portfolio_googledocs', $a);
+        $message->fullmessageformat = FORMAT_PLAIN;
+        $message->notification      = 1;
+        message_send($message);
+    }
+}
diff --git a/portfolio/picasa/db/upgrade.php b/portfolio/picasa/db/upgrade.php
index 8ced99d45cc..ee092b6b76c 100644
--- a/portfolio/picasa/db/upgrade.php
+++ b/portfolio/picasa/db/upgrade.php
@@ -20,6 +20,7 @@
  */
 function xmldb_portfolio_picasa_upgrade($oldversion) {
     global $CFG, $DB;
+    require_once(__DIR__.'/upgradelib.php');
 
     $dbman = $DB->get_manager();
 
@@ -49,28 +50,3 @@ function xmldb_portfolio_picasa_upgrade($oldversion) {
 
     return true;
 }
-
-function portfolio_picasa_admin_upgrade_notification() {
-    $admins = get_admins();
-
-    if (empty($admins)) {
-        return;
-    }
-    $a = new stdClass;
-    $a->docsurl = get_docs_url('Google_OAuth_2.0_setup');
-
-    foreach ($admins as $admin) {
-        $message = new stdClass();
-        $message->component         = 'moodle';
-        $message->name              = 'notices';
-        $message->userfrom          = get_admin();
-        $message->userto            = $admin;
-        $message->smallmessage      = get_string('oauth2upgrade_message_small', 'portfolio_picasa');
-        $message->subject           = get_string('oauth2upgrade_message_subject', 'portfolio_picasa');
-        $message->fullmessage       = get_string('oauth2upgrade_message_content', 'portfolio_picasa', $a);
-        $message->fullmessagehtml   = get_string('oauth2upgrade_message_content', 'portfolio_picasa', $a);
-        $message->fullmessageformat = FORMAT_PLAIN;
-        $message->notification      = 1;
-        message_send($message);
-    }
-}
diff --git a/portfolio/picasa/db/upgradelib.php b/portfolio/picasa/db/upgradelib.php
new file mode 100644
index 00000000000..a711cbfc46f
--- /dev/null
+++ b/portfolio/picasa/db/upgradelib.php
@@ -0,0 +1,53 @@
+<?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/>.
+
+/**
+ * Picasa portfolio upgrade script.
+ *
+ * @package   portfolio_picasa
+ * @copyright 2013 Dan Poltawski <dan@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Inform admins about setup required for picasa change.
+ */
+function portfolio_picasa_admin_upgrade_notification() {
+    $admins = get_admins();
+
+    if (empty($admins)) {
+        return;
+    }
+    $a = new stdClass;
+    $a->docsurl = get_docs_url('Google_OAuth_2.0_setup');
+
+    foreach ($admins as $admin) {
+        $message = new stdClass();
+        $message->component         = 'moodle';
+        $message->name              = 'notices';
+        $message->userfrom          = get_admin();
+        $message->userto            = $admin;
+        $message->smallmessage      = get_string('oauth2upgrade_message_small', 'portfolio_picasa');
+        $message->subject           = get_string('oauth2upgrade_message_subject', 'portfolio_picasa');
+        $message->fullmessage       = get_string('oauth2upgrade_message_content', 'portfolio_picasa', $a);
+        $message->fullmessagehtml   = get_string('oauth2upgrade_message_content', 'portfolio_picasa', $a);
+        $message->fullmessageformat = FORMAT_PLAIN;
+        $message->notification      = 1;
+        message_send($message);
+    }
+}
diff --git a/repository/googledocs/db/upgrade.php b/repository/googledocs/db/upgrade.php
index 57ae6de7f3b..781617e4e7b 100644
--- a/repository/googledocs/db/upgrade.php
+++ b/repository/googledocs/db/upgrade.php
@@ -20,6 +20,7 @@
  */
 function xmldb_repository_googledocs_upgrade($oldversion) {
     global $CFG, $DB;
+    require_once(__DIR__.'/upgradelib.php');
 
     $dbman = $DB->get_manager();
 
@@ -52,28 +53,3 @@ function xmldb_repository_googledocs_upgrade($oldversion) {
 
     return true;
 }
-
-function repository_googledocs_admin_upgrade_notification() {
-    $admins = get_admins();
-
-    if (empty($admins)) {
-        return;
-    }
-
-    $a = new stdClass;
-    $a->docsurl = get_docs_url('Google_OAuth_2.0_setup');
-    foreach ($admins as $admin) {
-        $message = new stdClass();
-        $message->component         = 'moodle';
-        $message->name              = 'notices';
-        $message->userfrom          = get_admin();
-        $message->userto            = $admin;
-        $message->smallmessage      = get_string('oauth2upgrade_message_small', 'repository_googledocs');
-        $message->subject           = get_string('oauth2upgrade_message_subject', 'repository_googledocs');
-        $message->fullmessage       = get_string('oauth2upgrade_message_content', 'repository_googledocs', $a);
-        $message->fullmessagehtml   = get_string('oauth2upgrade_message_content', 'repository_googledocs', $a);
-        $message->fullmessageformat = FORMAT_PLAIN;
-        $message->notification      = 1;
-        message_send($message);
-    }
-}
diff --git a/repository/googledocs/db/upgradelib.php b/repository/googledocs/db/upgradelib.php
new file mode 100644
index 00000000000..c065bd0a87e
--- /dev/null
+++ b/repository/googledocs/db/upgradelib.php
@@ -0,0 +1,53 @@
+<?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/>.
+
+/**
+ * Googledocs repository upgrade script.
+ *
+ * @package   repository_googledocs
+ * @copyright 2013 Dan Poltawski <dan@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Inform admins about setup required for googledocs change.
+ */
+function repository_googledocs_admin_upgrade_notification() {
+    $admins = get_admins();
+
+    if (empty($admins)) {
+        return;
+    }
+
+    $a = new stdClass;
+    $a->docsurl = get_docs_url('Google_OAuth_2.0_setup');
+    foreach ($admins as $admin) {
+        $message = new stdClass();
+        $message->component         = 'moodle';
+        $message->name              = 'notices';
+        $message->userfrom          = get_admin();
+        $message->userto            = $admin;
+        $message->smallmessage      = get_string('oauth2upgrade_message_small', 'repository_googledocs');
+        $message->subject           = get_string('oauth2upgrade_message_subject', 'repository_googledocs');
+        $message->fullmessage       = get_string('oauth2upgrade_message_content', 'repository_googledocs', $a);
+        $message->fullmessagehtml   = get_string('oauth2upgrade_message_content', 'repository_googledocs', $a);
+        $message->fullmessageformat = FORMAT_PLAIN;
+        $message->notification      = 1;
+        message_send($message);
+    }
+}
diff --git a/repository/picasa/db/upgrade.php b/repository/picasa/db/upgrade.php
index c9132c1cdcc..214de0b3fb8 100644
--- a/repository/picasa/db/upgrade.php
+++ b/repository/picasa/db/upgrade.php
@@ -20,6 +20,7 @@
  */
 function xmldb_repository_picasa_upgrade($oldversion) {
     global $CFG, $DB;
+    require_once(__DIR__.'/upgradelib.php');
 
     $dbman = $DB->get_manager();
 
@@ -52,28 +53,3 @@ function xmldb_repository_picasa_upgrade($oldversion) {
 
     return true;
 }
-
-function repository_picasa_admin_upgrade_notification() {
-    $admins = get_admins();
-
-    if (empty($admins)) {
-        return;
-    }
-    $a = new stdClass;
-    $a->docsurl = get_docs_url('Google_OAuth_2.0_setup');
-
-    foreach ($admins as $admin) {
-        $message = new stdClass();
-        $message->component         = 'moodle';
-        $message->name              = 'notices';
-        $message->userfrom          = get_admin();
-        $message->userto            = $admin;
-        $message->smallmessage      = get_string('oauth2upgrade_message_small', 'repository_picasa');
-        $message->subject           = get_string('oauth2upgrade_message_subject', 'repository_picasa');
-        $message->fullmessage       = get_string('oauth2upgrade_message_content', 'repository_picasa', $a);
-        $message->fullmessagehtml   = get_string('oauth2upgrade_message_content', 'repository_picasa', $a);
-        $message->fullmessageformat = FORMAT_PLAIN;
-        $message->notification      = 1;
-        message_send($message);
-    }
-}
diff --git a/repository/picasa/db/upgradelib.php b/repository/picasa/db/upgradelib.php
new file mode 100644
index 00000000000..4d76af52bef
--- /dev/null
+++ b/repository/picasa/db/upgradelib.php
@@ -0,0 +1,53 @@
+<?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/>.
+
+/**
+ * Picasa repository upgrade script.
+ *
+ * @package   repository_picasa
+ * @copyright 2013 Dan Poltawski <dan@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Inform admins about setup required for google picasa change.
+ */
+function repository_picasa_admin_upgrade_notification() {
+    $admins = get_admins();
+
+    if (empty($admins)) {
+        return;
+    }
+    $a = new stdClass;
+    $a->docsurl = get_docs_url('Google_OAuth_2.0_setup');
+
+    foreach ($admins as $admin) {
+        $message = new stdClass();
+        $message->component         = 'moodle';
+        $message->name              = 'notices';
+        $message->userfrom          = get_admin();
+        $message->userto            = $admin;
+        $message->smallmessage      = get_string('oauth2upgrade_message_small', 'repository_picasa');
+        $message->subject           = get_string('oauth2upgrade_message_subject', 'repository_picasa');
+        $message->fullmessage       = get_string('oauth2upgrade_message_content', 'repository_picasa', $a);
+        $message->fullmessagehtml   = get_string('oauth2upgrade_message_content', 'repository_picasa', $a);
+        $message->fullmessageformat = FORMAT_PLAIN;
+        $message->notification      = 1;
+        message_send($message);
+    }
+}