Migrate depending on a subset of content-types (#20)

A new option, '--contenttype' or '-t', has been added to CLI to let
admins migrate mod_hvp activities based on their main library id.

In order to achieve this, a new parameter, '$libraryids', has been
added to get_sql_hvp_to_migrate API method, to get SQL for contents
using these libraries.

For now, no changes have been done in GUI because admins can order
by the "Content type" column if they want to migrate contents based
on the main library id.

Author: sarjona

classes/api.php

@@ -161,12 +161,16 @@ public static function migrate_hvp2h5p(int $hvpid, int $keeporiginal = self::KEE
      * is a good idea.
      *
      * @param  bool $count when true, returns the count SQL.
+     * @param  string $sort sorting criteria.
+     * @param  array $libraryids List of the library ids for the mod_hvp contents to migrate. Only contents with these
+     *               main libraries will be returned.
      * @return array containing sql to use and an array of params.
      */
-    public static function get_sql_hvp_to_migrate(bool $count = false, ?string $sort = null): array {
+    public static function get_sql_hvp_to_migrate(bool $count = false, ?string $sort = null, ?array $libraryids = null): array {
 
         self::fix_duplicated_hvp();
 
+        $params = [];
         if ($count) {
             $select = "COUNT(1)";
             $groupby = '';
@@ -176,6 +180,27 @@ public static function get_sql_hvp_to_migrate(bool $count = false, ?string $sort
             $groupby = 'GROUP BY h.id, h.course, c.fullname, h.name, hl.machine_name, cm.id';
         }
 
+        // Get only mod_hvp contents with main library in libraryids (if defined).
+        $where = 'mgr.id IS NULL';
+        if (!empty($libraryids)) {
+            $i = 1;
+            foreach ($libraryids as $libraryid) {
+                if (is_numeric($libraryid)) {
+                    if ($i > 1) {
+                        $where .= ' OR ';
+                    } else {
+                        $where .= ' AND (';
+                    }
+                    $where .= 'h.main_library_id = :libraryid' . $i;
+                    $params['libraryid' . $i] = $libraryid;
+                    $i++;
+                }
+            }
+            if ($i > 1) {
+                $where .= ')';
+            }
+        }
+
         // We need to select the hvp activities which are not migrated but ignoring the activities in the recycle bin.
         // The most efficient way seems to have a subtable with all non-delete h5p activities.
         $sql = "SELECT $select
@@ -194,14 +219,14 @@ public static function get_sql_hvp_to_migrate(bool $count = false, ?string $sort
                                  AND i.id = mgrcm.instance AND mgrcm.deletioninprogress = 0
                        ) mgr
                        ON mgr.name = h.name AND mgr.timecreated = h.timecreated AND mgr.course = h.course
-                 WHERE mgr.id IS NULL
+                 WHERE $where
                        $groupby";
 
         if (!empty($sort)) {
             $sql .= " ORDER BY " . $sort;
         }
 
-        return [$sql, []];
+        return [$sql, $params];
     }
 
     /**

cli/migrate.php

@@ -37,12 +37,14 @@
         'limit' => 100,
         'keeporiginal' => 1,
         'copy2cb' => api::COPY2CBYESWITHLINK,
+        'contenttypes' => [],
     ], [
         'e' => 'execute',
         'h' => 'help',
         'l' => 'limit',
         'k' => 'keeporiginal',
         'c' => 'copy2cb',
+        't' => 'contenttypes',
     ]
 );
 
@@ -60,8 +62,10 @@
  -e, --execute             Run the migration tool
  -k, --keeporiginal=N      After migration 0 will remove the original activity, 1 will keep it and 2 will hide it
  -c, --copy2cb=N           Whether H5P files should be added to the content bank with a link (1), as a copy (2) or not added (0)
+ -t, --contenttypes=N      The library ids, separated by commas, for the mod_hvp contents to migrate.
+                           Only contents having these libraries defined as main library will be migrated.
  -l  --limit=N             The maximmum number of activities per execution (default 100).
-                                Already migrated activities will be ignored.
+                           Already migrated activities will be ignored.
 
 Example:
 \$sudo -u www-data /usr/bin/php admin/tool/migratehvp2h5p/cli/migrate.php --execute
@@ -90,6 +94,12 @@
     $options['copy2cb'] = api::COPY2CBYESWITHLINK;
 }
 
+if (!empty($options['contenttypes'])) {
+    $ctparam = explode(',', $options['contenttypes']);
+} else {
+    $ctparam = [];
+}
+
 $keeporiginal = $options['keeporiginal'];
 $copy2cb = $options['copy2cb'];
 $limit = $options['limit'] ?? 100;
@@ -110,6 +120,18 @@
     exit(1);
 }
 
+$contenttypes = [];
+if (!empty($ctparam)) {
+    foreach ($ctparam as $contenttype) {
+        if (!is_numeric($contenttype)) {
+            echo "contenttypes must be a list of library ids separated by commas.\n";
+            exit(1);
+        } else {
+            $contenttypes[] = intval($contenttype);
+        }
+    }
+}
+
 core_php_time_limit::raise();
 
 // Increase memory limit.
@@ -124,7 +146,7 @@
 
 mtrace("Search for $limit non migrated hvp activites\n");
 
-list($sql, $params) = api::get_sql_hvp_to_migrate();
+list($sql, $params) = api::get_sql_hvp_to_migrate(false, null, $contenttypes);
 if (!empty($limit)) {
     $sql .= " LIMIT " . $limit;
 }