Merge pull request #628 from nextcloud/compatibility/nc21

Enable compatibility for NC 21
nextcloud · Mar 3, 2021 · 382cd98 · 382cd98
2 parents c3a4529 + ed464ed
commit 382cd98
Show file tree

Hide file tree

Showing 6 changed files with 93 additions and 36 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -81,7 +81,7 @@ jobs:
                 - pgsql
                 - sqlite
             coreVersion:
-                - stable20
+                - stable21
             phpVersion:
                 - "7"
             httpServer:
@@ -100,17 +100,22 @@ jobs:
                     phpVersion: "7"
                     httpServer: "apache"
                     mayFail: false
+                -   database: mysql
+                    coreVersion: stable20
+                    phpVersion: "7"
+                    httpServer: "apache"
+                    mayFail: false
 
                 # Test different PHP versions additionally
                 -   database: mysql
-                    coreVersion: stable20
+                    coreVersion: stable21
                     phpVersion: "7.3"
                     httpServer: "apache"
                     mayFail: false
 
                 # Test different HTTP server
                 -   database: mysql
-                    coreVersion: stable20
+                    coreVersion: stable21
                     phpVersion: "7"
                     httpServer: "nginx"
                     mayFail: false

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,8 @@
   [#620](https://github.com/nextcloud/cookbook/pull/620) @christianlupus
 - Avoid descending of CS_fixer into non-code folders
   [#621](https://github.com/nextcloud/cookbook/pull/621) @christianlupus
+- Fixed compatiblity with Nextcloud 21
+  [#605](https://github.com/nextcloud/cookbook/pull/605) @icewind1991
 
 ## Deprecated
 - Obsolete routes to old user interface, see `appinfo/routes.php`

diff --git a/appinfo/info.xml b/appinfo/info.xml
@@ -16,7 +16,7 @@
     <screenshot small-thumbnail="https://raw.githubusercontent.com/nextcloud/cookbook/stable/img/screenshot-small.jpg">https://raw.githubusercontent.com/nextcloud/cookbook/stable/img/screenshot-small.jpg</screenshot>
     <dependencies>
         <php min-version="7.2"/>
-        <nextcloud min-version="17" max-version="20"/>
+        <nextcloud min-version="17" max-version="21"/>
     </dependencies>
     <navigations>
         <navigation>

diff --git a/lib/Db/DbTypesPolyfillHelper.php b/lib/Db/DbTypesPolyfillHelper.php
@@ -0,0 +1,46 @@
+<?php
+
+namespace OCA\Cookbook\Db;
+
+use OCP\Util;
+
+class DbTypesPolyfillHelper {
+	/**
+	 * @var String
+	 */
+	private $int;
+	/**
+	 * @var String
+	 */
+	private $string;
+
+	public function __construct(Util $util) {
+		switch ($util->getVersion()[0]) {
+			case 18:
+			case 19:
+			case 20:
+				$this->int = \Doctrine\DBAL\Types\Type::INTEGER;
+				$this->string = \Doctrine\DBAL\Types\Type::STRING;
+				break;
+
+			default:
+				$this->int = \OCP\DB\Types::INTEGER;
+				$this->string = \OCP\DB\Types::STRING;
+				break;
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	final public function INT() {
+		return $this->int;
+	}
+
+	/**
+	 * @return string
+	 */
+	final public function STRING() {
+		return $this->string;
+	}
+}
diff --git a/lib/Db/RecipeDb.php b/lib/Db/RecipeDb.php
@@ -3,7 +3,6 @@
 namespace OCA\Cookbook\Db;
 
 use OCP\DB\QueryBuilder\IQueryBuilder;
-use Doctrine\DBAL\Types\Type;
 use OCP\IDBConnection;
 use OCP\AppFramework\Db\DoesNotExistException;
 
@@ -14,8 +13,14 @@ class RecipeDb {
 
 	private $db;
 
-	public function __construct(IDBConnection $db) {
+	/**
+	 * @var DbTypesPolyfillHelper
+	 */
+	private $types;
+
+	public function __construct(IDBConnection $db, DbTypesPolyfillHelper $polyfillTypes) {
 		$this->db = $db;
+		$this->types = $polyfillTypes;
 	}
 
 	/**
@@ -79,7 +84,7 @@ public function findAllRecipes(string $user_id) {
 			->from(self::DB_TABLE_RECIPES, 'r')
 			->where('r.user_id = :user')
 			->orderBy('r.name');
-		$qb->setParameter('user', $user_id, TYPE::STRING);
+		$qb->setParameter('user', $user_id, $this->types->STRING());
 		$qb->leftJoin('r', self::DB_TABLE_KEYWORDS, 'k',
 			$qb->expr()->andX(
 				'r.recipe_id = k.recipe_id',
@@ -136,7 +141,7 @@ public function findAllKeywords(string $user_id) {
 			->where('user_id = :user AND k.name != \'\'')
 			->groupBy('k.name')
 			->orderBy('k.name');
-		$qb->setParameter('user', $user_id, TYPE::STRING);
+		$qb->setParameter('user', $user_id, $this->types->STRING());
 
 		$cursor = $qb->execute();
 		$result = $cursor->fetchAll();
@@ -160,7 +165,7 @@ public function findAllCategories(string $user_id) {
 			->where('user_id = :user')
 			->groupBy('c.name')
 			->orderBy('c.name');
-		$qb->setParameter('user', $user_id, TYPE::STRING);
+		$qb->setParameter('user', $user_id, $this->types->STRING());
 
 		$cursor = $qb->execute();
 		$result = $cursor->fetchAll();
@@ -217,8 +222,8 @@ public function getRecipesByCategory(string $category, string $user_id) {
 				->from(self::DB_TABLE_CATEGORIES, 'c')
 				->where('c.name = :category')
 				->andWhere('c.user_id = :user')
-				->setParameter('category', $category, TYPE::STRING)
-				->setParameter('user', $user_id, TYPE::STRING);
+				->setParameter('category', $category, $this->types->STRING())
+				->setParameter('user', $user_id, $this->types->STRING());
 
 			$qb->join('c', self::DB_TABLE_RECIPES, 'r', 'c.recipe_id = r.recipe_id');
 			$qb->leftJoin('c', self::DB_TABLE_KEYWORDS, 'k', 'c.recipe_id = k.recipe_id');
@@ -268,9 +273,9 @@ public function getRecipesByKeywords(string $keywords, string $user_id) {
 		->where('k.name IN (:keywords)')
 		->andWhere('k.user_id = :user')
 		->having('COUNT(DISTINCT k.name) = :keywordsCount')
-		->setParameter('user', $user_id, TYPE::INTEGER)
+		->setParameter('user', $user_id, $this->types->INT())
 		->setParameter('keywords', $keywords_arr, IQueryBuilder::PARAM_STR_ARRAY)
-		->setParameter('keywordsCount', sizeof($keywords_arr), TYPE::INTEGER);
+		->setParameter('keywordsCount', sizeof($keywords_arr), $this->types->INT());
 		$qb->join('k', self::DB_TABLE_RECIPES, 'r', 'k.recipe_id = r.recipe_id');
 		$qb->join('r', self::DB_TABLE_KEYWORDS, 'kk', 'kk.recipe_id = r.recipe_id');
 		$qb->groupBy(['r.name', 'r.recipe_id', 'kk.name']);
@@ -316,14 +321,14 @@ public function findRecipes(array $keywords, string $user_id) {
 			$qb->orWhere("LOWER(c.name) LIKE :keyword$paramIdx");
 
 			$params["keyword$paramIdx"] = "%$lowerKeyword%";
-			$types["keyword$paramIdx"] = Type::STRING;
+			$types["keyword$paramIdx"] = $this->types->STRING();
 			$paramIdx++;
 		}
 
 		$qb->andWhere('r.user_id = :user');
 
 		$qb->setParameters($params, $types);
-		$qb->setParameter('user', $user_id, TYPE::STRING);
+		$qb->setParameter('user', $user_id, $this->types->STRING());
 
 		$qb->groupBy(['r.name', 'r.recipe_id', 'k.name']);
 		$qb->orderBy('r.name');
@@ -366,22 +371,22 @@ public function emptySearchIndex(string $user_id) {
 		$qb->delete(self::DB_TABLE_RECIPES)
 			->where('user_id = :user')
 			->orWhere('user_id = :empty');
-		$qb->setParameter('user', $user_id, TYPE::STRING);
-		$qb->setParameter('empty', 'empty', TYPE::STRING);
+		$qb->setParameter('user', $user_id, $this->types->STRING());
+		$qb->setParameter('empty', 'empty', $this->types->STRING());
 
 		$qb->execute();
 
 		$qb->delete(self::DB_TABLE_KEYWORDS)
 			->where('user_id = :user')
 			->orWhere('user_id = :empty');
-		$qb->setParameter('user', $user_id, TYPE::STRING);
-		$qb->setParameter('empty', 'empty', TYPE::STRING);
+		$qb->setParameter('user', $user_id, $this->types->STRING());
+		$qb->setParameter('empty', 'empty', $this->types->STRING());
 
 		$qb->delete(self::DB_TABLE_CATEGORIES)
 			->where('user_id = :user')
 			->orWhere('user_id = :empty');
-		$qb->setParameter('user', $user_id, TYPE::STRING);
-		$qb->setParameter('empty', 'empty', TYPE::STRING);
+		$qb->setParameter('user', $user_id, $this->types->STRING());
+		$qb->setParameter('empty', 'empty', $this->types->STRING());
 
 		$qb->execute();
 	}
@@ -444,8 +449,8 @@ public function insertRecipes(array $recipes, string $userId) {
 		$qb->setParameter('userid', $userId);
 
 		foreach ($recipes as $recipe) {
-			$qb->setParameter('id', $recipe['id'], Type::INTEGER);
-			$qb->setParameter('name', $recipe['name'], Type::STRING);
+			$qb->setParameter('id', $recipe['id'], $this->types->INT());
+			$qb->setParameter('name', $recipe['name'], $this->types->STRING());
 
 			$qb->execute();
 		}
@@ -521,8 +526,8 @@ public function updateCategoryOfRecipe(int $recipeId, string $categoryName, stri
 		$qb->update(self::DB_TABLE_CATEGORIES)
 			->where('recipe_id = :rid', 'user_id = :user');
 		$qb->set('name', $qb->expr()->literal($categoryName, IQueryBuilder::PARAM_STR));
-		$qb->setParameter('rid', $recipeId, Type::INTEGER);
-		$qb->setParameter('user', $userId, Type::STRING);
+		$qb->setParameter('rid', $recipeId, $this->types->INT());
+		$qb->setParameter('user', $userId, $this->types->STRING());
 		$qb->execute();
 	}
 
@@ -539,9 +544,9 @@ public function addCategoryOfRecipe(int $recipeId, string $categoryName, string
 		$qb = $this->db->getQueryBuilder();
 		$qb->insert(self::DB_TABLE_CATEGORIES)
 			->values(['recipe_id' => ':rid', 'name' => ':name', 'user_id' => ':user']);
-		$qb->setParameter('rid', $recipeId, Type::INTEGER);
-		$qb->setParameter('name', $categoryName, Type::STRING);
-		$qb->setParameter('user', $userId, Type::STRING);
+		$qb->setParameter('rid', $recipeId, $this->types->INT());
+		$qb->setParameter('name', $categoryName, $this->types->STRING());
+		$qb->setParameter('user', $userId, $this->types->STRING());
 
 		try {
 			$qb->execute();
@@ -554,8 +559,8 @@ public function removeCategoryOfRecipe(int $recipeId, string $userId) {
 		$qb = $this->db->getQueryBuilder();
 		$qb->delete(self::DB_TABLE_CATEGORIES)
 			->where('recipe_id = :rid', 'user_id = :user');
-		$qb->setParameter('rid', $recipeId, Type::INTEGER);
-		$qb->setParameter('user', $userId, Type::STRING);
+		$qb->setParameter('rid', $recipeId, $this->types->INT());
+		$qb->setParameter('user', $userId, $this->types->STRING());
 		$qb->execute();
 	}
 
@@ -567,11 +572,11 @@ public function addKeywordPairs(array $pairs, string $userId) {
 		$qb = $this->db->getQueryBuilder();
 		$qb->insert(self::DB_TABLE_KEYWORDS)
 			->values(['recipe_id' => ':rid', 'name' => ':name', 'user_id' => ':user']);
-		$qb->setParameter('user', $userId, Type::STRING);
+		$qb->setParameter('user', $userId, $this->types->STRING());
 
 		foreach ($pairs as $p) {
-			$qb->setParameter('rid', $p['recipeId'], Type::INTEGER);
-			$qb->setParameter('name', $p['name'], Type::STRING);
+			$qb->setParameter('rid', $p['recipeId'], $this->types->INT());
+			$qb->setParameter('name', $p['name'], $this->types->STRING());
 
 			try {
 				$qb->execute();

diff --git a/lib/Migration/Version000000Date20190910100911.php b/lib/Migration/Version000000Date20190910100911.php
@@ -6,7 +6,6 @@
 use OCP\DB\ISchemaWrapper;
 use OCP\Migration\SimpleMigrationStep;
 use OCP\Migration\IOutput;
-use Doctrine\DBAL\Types\Type;
 
 class Version000000Date20190910100911 extends SimpleMigrationStep {
 	/**
@@ -22,7 +21,7 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 		$recipes_table = $schema->getTable('cookbook_recipes');
 
 		if (!$recipes_table->hasColumn('user_id')) {
-			$recipes_table->addColumn('user_id', Type::STRING, [
+			$recipes_table->addColumn('user_id', 'string', [
 				'notnull' => true,
 				'length' => 64,
 				'default' => 'empty',
@@ -32,7 +31,7 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 		$keywords_table = $schema->getTable('cookbook_keywords');
 
 		if (!$keywords_table->hasColumn('user_id')) {
-			$keywords_table->addColumn('user_id', Type::STRING, [
+			$keywords_table->addColumn('user_id', 'string', [
 				'notnull' => true,
 				'length' => 64,
 				'default' => 'empty',