Merge 036bacc into 44fe2a1

Author: christianlupus

.php-cs-fixer.dist.php

@@ -6,7 +6,26 @@
 
 use Nextcloud\CodingStandard\Config;
 
-$config = new Config();
+class CookbookConfig extends Config {
+	public function __construct($name = 'default') {
+		parent::__construct($name);
+	}
+
+	public function getRules() : array {
+		$parentRules = parent::getRules();
+		$additionalRules = [
+			'phpdoc_add_missing_param_annotation' => true,
+			'phpdoc_indent' => true,
+			'phpdoc_no_empty_return' => true,
+			'phpdoc_scalar' => true,
+			'phpdoc_single_line_var_spacing' => true,
+			'phpdoc_var_without_name' => true
+		];
+		return array_merge(['@PSR12' => true], $parentRules, $additionalRules);
+	}
+}
+
+$config = new CookbookConfig();
 $config
 	->getFinder()
 	->ignoreVCSIgnored(true)
@@ -18,5 +37,7 @@
 	->exclude('vendor')
 	->exclude('.github')
 	->in(__DIR__);
+
+
 return $config;
 

CHANGELOG.md

@@ -7,6 +7,10 @@
   [#988](https://github.com/nextcloud/cookbook/pull/988) @rakekniven
 - Move "Categories" caption above list of categories
   [#1000](https://github.com/nextcloud/cookbook/pull/1000) @seyfeb
+- Prevent access to guzzle client without explicit dependency
+  [#1011](https://github.com/nextcloud/cookbook/pull/1011) @christianlupus
+- Make PHP code styling more strict
+  [#1011](https://github.com/nextcloud/cookbook/pull/1011) @christianlupus
 
 ### Documentation
 - Add documentation on updates of the API endpoints

lib/AppInfo/Application.php

@@ -14,7 +14,7 @@
 if (Util::getVersion()[0] >= 20) {
 	class Application extends App implements IBootstrap {
 		public const APP_ID = 'cookbook';
-		
+
 		public function __construct(array $urlParams = []) {
 			parent::__construct(self::APP_ID, $urlParams);
 		}
@@ -29,7 +29,7 @@ public function boot(IBootContext $context): void {
 } else {
 	class Application extends App {
 		public const APP_ID = 'cookbook';
-		
+
 		public function __construct(array $urlParams = []) {
 			parent::__construct(self::APP_ID, $urlParams);
 		}

lib/Controller/ConfigController.php

@@ -16,12 +16,12 @@ class ConfigController extends Controller {
 	 * @var RecipeService
 	 */
 	private $service;
-	
+
 	/**
 	 * @var DbCacheService
 	 */
 	private $dbCacheService;
-	
+
 	/**
 	 * @var RestParameterParser
 	 */
@@ -41,7 +41,7 @@ public function __construct($AppName, IRequest $request, RecipeService $recipeSe
 	 */
 	public function list() {
 		$this->dbCacheService->triggerCheck();
-		
+
 		return new DataResponse([
 			'folder' => $this->service->getUserFolderPath(),
 			'update_interval' => $this->dbCacheService->getSearchIndexUpdateInterval(),
@@ -55,7 +55,7 @@ public function list() {
 	 */
 	public function config() {
 		$data = $this->restParser->getParameters();
-		
+
 		if (isset($data['folder'])) {
 			$this->service->setUserFolderPath($data['folder']);
 			$this->dbCacheService->updateCache();
@@ -70,10 +70,10 @@ public function config() {
 		}
 
 		$this->dbCacheService->triggerCheck();
-		
+
 		return new DataResponse('OK', Http::STATUS_OK);
 	}
-	
+
 	/**
 	 * @NoAdminRequired
 	 * @NoCSRFRequired

lib/Controller/MainController.php

@@ -32,7 +32,7 @@ class MainController extends Controller {
 	 * @var IURLGenerator
 	 */
 	private $urlGenerator;
-	
+
 	/**
 	 * @var RestParameterParser
 	 */
@@ -68,13 +68,13 @@ public function index(): TemplateResponse {
 		 * will prevent the controller to be called. If this does not happen for some reason, let the exception be
 		 * thrown and the user most probably has found a bug. A stack trace might help there.
 		 */
-		
+
 		$this->dbCacheService->triggerCheck();
 
 		Util::addScript('cookbook', 'nextcloud-cookbook-main');
 		return new TemplateResponse($this->appName, 'index');  // templates/index.php
 	}
-	
+
 	/**
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
@@ -98,7 +98,7 @@ public function getApiVersion(): DataResponse {
 	 */
 	public function categories() {
 		$this->dbCacheService->triggerCheck();
-		
+
 		$categories = $this->service->getAllCategoriesInSearchIndex();
 		return new DataResponse($categories, 200, ['Content-Type' => 'application/json']);
 	}
@@ -109,18 +109,19 @@ public function categories() {
 	 */
 	public function keywords() {
 		$this->dbCacheService->triggerCheck();
-		
+
 		$keywords = $this->service->getAllKeywordsInSearchIndex();
 		return new DataResponse($keywords, 200, ['Content-Type' => 'application/json']);
 	}
 
 	/**
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
+	 * @param string $query
 	 */
 	public function search($query) {
 		$this->dbCacheService->triggerCheck();
-		
+
 		$query = urldecode($query);
 		try {
 			$recipes = $this->service->findRecipesInSearchIndex($query);
@@ -152,10 +153,11 @@ public function search($query) {
 	/**
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
+	 * @param string $category
 	 */
 	public function category($category) {
 		$this->dbCacheService->triggerCheck();
-		
+
 		$category = urldecode($category);
 		try {
 			$recipes = $this->service->getRecipesByCategory($category);
@@ -186,6 +188,7 @@ public function category($category) {
 	/**
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
+	 * @param string $category
 	 */
 	public function categoryUpdate($category) {
 		$this->dbCacheService->triggerCheck();
@@ -215,6 +218,7 @@ public function categoryUpdate($category) {
 	/**
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
+	 * @param string $keywords
 	 */
 	public function tags($keywords) {
 		$this->dbCacheService->triggerCheck();
@@ -253,9 +257,9 @@ public function tags($keywords) {
 	 */
 	public function import() {
 		$this->dbCacheService->triggerCheck();
-		
+
 		$data = $this->restParser->getParameters();
-		
+
 		if (!isset($data['url'])) {
 			return new DataResponse('Field "url" is required', 400);
 		}
@@ -284,7 +288,7 @@ public function import() {
 	 */
 	public function new() {
 		$this->dbCacheService->triggerCheck();
-		
+
 		try {
 			$recipe_data = $this->restParser->getParameters();
 			$file = $this->service->addRecipe($recipe_data);
@@ -299,18 +303,19 @@ public function new() {
 	/**
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
+	 * @param int $id
 	 */
 	public function update($id) {
 		$this->dbCacheService->triggerCheck();
-		
+
 		try {
 			$recipe_data = $this->restParser->getParameters();
 
 			$recipe_data['id'] = $id;
 
 			$file = $this->service->addRecipe($recipe_data);
 			$this->dbCacheService->addRecipe($file);
-			
+
 			return new DataResponse($id);
 		} catch (\Exception $e) {
 			return new DataResponse($e->getMessage(), 500);

lib/Controller/RecipeController.php

@@ -28,12 +28,12 @@ class RecipeController extends Controller {
 	 * @var IURLGenerator
 	 */
 	private $urlGenerator;
-	
+
 	/**
 	 * @var DbCacheService
 	 */
 	private $dbCacheService;
-	
+
 	/**
 	 * @var RestParameterParser
 	 */
@@ -75,7 +75,7 @@ public function __construct(
 	 */
 	public function index() {
 		$this->dbCacheService->triggerCheck();
-		
+
 		if (empty($_GET['keywords'])) {
 			$recipes = $this->service->getAllRecipesInSearchIndex();
 		} else {
@@ -96,7 +96,7 @@ public function index() {
 	 */
 	public function show($id) {
 		$this->dbCacheService->triggerCheck();
-		
+
 		$json = $this->service->getRecipeById($id);
 
 		if (null === $json) {
@@ -105,7 +105,7 @@ public function show($id) {
 
 		$json['printImage'] = $this->service->getPrintImage();
 		$json['imageUrl'] = $this->urlGenerator->linkToRoute('cookbook.recipe.image', ['id' => $json['id'], 'size' => 'full']);
-		
+
 		return new DataResponse($json, Http::STATUS_OK, ['Content-Type' => 'application/json']);
 	}
 
@@ -122,7 +122,7 @@ public function show($id) {
 	 */
 	public function update($id) {
 		$this->dbCacheService->triggerCheck();
-		
+
 		$recipeData = $this->restParser->getParameters();
 		try {
 			$file = $this->service->addRecipe($recipeData);
@@ -151,12 +151,12 @@ public function update($id) {
 	 */
 	public function create() {
 		$this->dbCacheService->triggerCheck();
-		
+
 		$recipeData = $this->restParser->getParameters();
 		try {
 			$file = $this->service->addRecipe($recipeData);
 			$this->dbCacheService->addRecipe($file);
-	
+
 			return new DataResponse($file->getParent()->getId(), Http::STATUS_OK, ['Content-Type' => 'application/json']);
 		} catch (RecipeExistsException $ex) {
 			$json = [
@@ -183,7 +183,7 @@ public function create() {
 	 */
 	public function destroy($id) {
 		$this->dbCacheService->triggerCheck();
-		
+
 		try {
 			$this->service->deleteRecipe($id);
 			return new DataResponse('Recipe ' . $id . ' deleted successfully', Http::STATUS_OK);
@@ -200,7 +200,7 @@ public function destroy($id) {
 	 */
 	public function image($id) {
 		$this->dbCacheService->triggerCheck();
-		
+
 		$acceptHeader = $this->request->getHeader('Accept');
 		$acceptedExtensions = $this->acceptHeaderParser->parseHeader($acceptHeader);
 
@@ -220,7 +220,7 @@ public function image($id) {
 			} else {
 				// The client accepts the SVG file. Send it.
 				$file = file_get_contents(dirname(__FILE__) . '/../../img/recipe.svg');
-	
+
 				return new DataDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => 'image/svg+xml']);
 			}
 		}

lib/Db/DbTypesPolyfillHelper.php

@@ -13,7 +13,7 @@ class DbTypesPolyfillHelper {
 	 * @var String
 	 */
 	private $string;
-	
+
 	public function __construct(Util $util) {
 		switch ($util->getVersion()[0]) {
 			case 18:
@@ -22,14 +22,14 @@ public function __construct(Util $util) {
 				$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
 	 */