Merge branch 'dev'

Author: dadish

Todo.md

@@ -20,9 +20,6 @@ with particular height and/or width. If there isn't a thumbnail variation with s
 size, then create it.
 - Mind permissions for thumbnail creation.
 
-### Add support for LanguageFields
-By default the content of the LanguageFields should resolve to the `$user->language`.
-In addition to that there will be a top level field called `language` which will
-allow the client to choose the language for each request.
+#### Make GraphQL processing a hookable method for extra user control
 
 [n1-problem]: https://secure.phabricator.com/book/phabcontrib/article/n_plus_one/

src/Config.php

@@ -4,6 +4,7 @@
 
 use ProcessWire\WireData;
 use ProcessWire\ProcessGraphQL;
+use ProcessWire\GraphQL\Utils;
 
 class Config extends WireData {
 
@@ -13,34 +14,38 @@ public function __construct(ProcessGraphQL $module)
   {
     $this->module = $module;
 
-    // cache reference for useful ProcessWire API variables
-    $apiVars = [
-      'templates',
-      'fields',
-      'roles',
-      'users',
-      'pages',
-    ];
-    foreach ($apiVars as $varName) {
-      $this->$varName = \ProcessWire\wire($varName);
-    }
-
     // Assign Config to module so we can access it easily accross the module codebase.
     $module->Config = $this;
+
+    // Wierd behavior with ProcessWire. $user->hasPermission() does not
+    // work if you do not load the required roles beforehand.
+    Utils::roles()->find("");
   }
 
   public function get($key)
   {
+    $super = Utils::user()->isSuperuser();
     switch ($key) {
       case 'maxLimit':
       case 'fullWidthGraphiQL':
       case 'legalPageFields':
       case 'legalPageFileFields':
         return $this->module->$key;
-      case 'legalTemplates':
-        return $this->getLegalTemplates();
-      case 'legalFields':
-        return $this->getLegalFields();
+      case 'legalViewTemplates':
+        if ($super) return $this->getLegalTemplates();
+        return $this->getLegalTemplatesForPermission('page-view');
+      case 'legalCreateTemplates':
+        if ($super) return $this->getLegalTemplates();
+        return $this->getLegalTemplatesForPermission('page-create');
+      case 'legalEditTemplates':
+        if ($super) return $this->getLegalTemplates();
+        return $this->getLegalTemplatesForPermission('page-edit');
+      case 'legalViewFields':
+        if ($super) return $this->getLegalFields();
+        return $this->getLegalFieldsForPermission('view');
+      case 'legalEditFields':
+        if ($super) return $this->getLegalFields();
+        return $this->getLegalFieldsForPermission('edit');
       default:
         return parent::get($key);
     }
@@ -49,28 +54,45 @@ public function get($key)
   protected function getLegalTemplates()
   {
     $legalTemplates = $this->module->legalTemplates;
-    $templates = \ProcessWire\wire('templates')->find("name=" . implode('|', $legalTemplates));
-    $user = \ProcessWire\wire('user');
-
-    // Wierd behavior with ProcessWire. $user->hasPermission() does not
-    // work if you do not load the required roles beforehand.
-    \ProcessWire\wire('roles')->find("");
+    return Utils::templates()->find("name=" . implode('|', $legalTemplates));
+  }
 
+  protected function getLegalTemplatesForPermission($permission = 'page-view')
+  {
+    $templates = $this->getLegalTemplates()->find("useRoles=1");
     foreach ($templates as $template) {
-      // We serve only those that user has permission to view
-      if (!$user->hasTemplatePermission('page-view', $template)) {
+      if (!Utils::user()->hasTemplatePermission($permission, $template)) {
         $templates->remove($template);
       }
     }
-
     return $templates;
   }
 
   protected function getLegalFields()
   {
     $legalFields = $this->module->legalFields;
-    $fields = \ProcessWire\wire('fields')->find("name=" . implode('|', $legalFields));
+    return Utils::fields()->find("name=" . implode('|', $legalFields));
+  }
+
+  protected function getLegalFieldsForPermission($permission = 'view')
+  {
+    $fields = $this->getLegalFields()->find("useRoles=1");
+    $rolesType = $permission . "Roles";
+    foreach ($fields as $field) {
+      if (!$this->userHasPermission($field->$rolesType)) {
+        $fields->remove($field);
+      }
+    }
     return $fields;
   }
 
+  protected function userHasPermission($rolesID)
+  {
+    $userRolesID = Utils::user()->roles->explode('id');
+    foreach ($userRolesID as $userRoleID) {
+      if (in_array($userRoleID, $rolesID)) return true;
+    }
+    return false;
+  }
+
 }

src/Field/PageImage/EmptyPageImage.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace ProcessWire\GraphQL\Field\PageImage;
+
+use ProcessWire\WireData;
+use ProcessWire\WireArray;
+
+class EmptyPageImage extends WireData {
+
+  public function getVariations()
+  {
+    return new WireArray();
+  }
+
+}

src/Field/PageImage/PageImageSizeField.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace ProcessWire\GraphQL\Field\PageImage;
+
+use Youshido\GraphQL\Field\AbstractField;
+use Youshido\GraphQL\Config\Field\FieldConfig;
+use Youshido\GraphQL\Type\Scalar\IntType;
+use ProcessWire\GraphQL\Type\Object\PageImageType;
+use Youshido\GraphQL\Execution\ResolveInfo;
+use ProcessWire\GraphQL\Utils;
+use ProcessWire\GraphQL\Field\PageImage\EmptyPageImage;
+
+class PageImageSizeField extends AbstractField{
+
+  public function getType()
+  {
+    return new PageImageType();
+  }
+
+  public function getName()
+  {
+    return 'size';
+  }
+
+  public function getDescription()
+  {
+    return 'Create a thumbnail of the PageImage with the desired size.';
+  }
+
+  public function build(FieldConfig $config)
+  {
+    $config->addArgument('width', [
+      'type' => new IntType(),
+      'description' => 'Target width of the new image',
+    ]);
+    $config->addArgument('height', [
+      'type' => new IntType(),
+      'description' => 'Target height of the new image',
+    ]);
+  }
+
+  public function resolve($value, array $args, ResolveInfo $info)
+  {
+    $canCreate = Utils::moduleConfig()->legalEditFields->has($value->field);
+    $width = isset($args['width']) ? $args['width'] : null;
+    $height = isset($args['height']) ? $args['height'] : null;
+
+    // if there neither width nor heigth is given then we return empty image
+    if (!$width && !$height) return new EmptyPageImage();
+
+    // we create the image if user have rights for it
+    if ($canCreate) return $value->size($width, $height);
+
+    // if user has no rights to create the image then she
+    // might be asking for variation already created
+    $options = [];
+    if ($width) $options['width'] = $width;
+    if ($height) $options['height'] = $height;
+    $thumbs = $value->getVariations($options);
+
+    // If we find the variation then return it
+    // otherwise return empty
+    if ($thumbs->count()) return $thumbs->first();
+    return new EmptyPageImage();
+  }
+}

src/Schema.php

@@ -27,7 +27,7 @@ public function build(SchemaConfig $config)
     $query->addField(new PagesField());
 
     // $templates
-    foreach (Utils::moduleConfig()->legalTemplates as $template) {
+    foreach (Utils::moduleConfig()->legalViewTemplates as $template) {
       $query->addField(new TemplatedPageArrayField($template));
     }
 
@@ -54,7 +54,7 @@ public function build(SchemaConfig $config)
     $mutation = $config->getMutation();
 
     // CreatePage
-    foreach (Utils::moduleConfig()->legalTemplates as $template) {
+    foreach (Utils::moduleConfig()->legalCreateTemplates as $template) {
       $mutation->addField(new CreateTemplatedPage($template));
     }
 

src/Type/InterfaceType/PageFileInterfaceType.php

@@ -53,7 +53,7 @@ public static function getPageFileFields()
         'type' => new StringType(),
         'description' => 'The web accessible URL (with scheme and hostname) to this Pagefile.',
         'resolve' => function ($value) {
-          return (string) $value->httpUrl();
+          return (string) $value->httpUrl;
         }
       ],
 
@@ -133,4 +133,4 @@ public static function getPageFileFields()
   }
 
 
-}
+}

src/Type/InterfaceType/PageInterfaceType.php

@@ -23,15 +23,15 @@ public function build($config)
   {
     $fields = self::getPageFields();
     $legalPageFields = Utils::moduleConfig()->legalPageFields;
-    
+
     foreach ($fields as $fieldName => $fieldClassName) {
       if (!in_array($fieldName, $legalPageFields)) continue;
       $className = "ProcessWire\\GraphQL\\Field\\Page\\$fieldClassName";
       $config->addField(new $className());
     }
 
     // add global fields too
-    $legalFields = Utils::moduleConfig()->legalFields;
+    $legalFields = Utils::moduleConfig()->legalViewFields;
     foreach ($legalFields as $field) {
       if ($field->flags & Field::flagGlobal) {
         $className = "\\ProcessWire\\GraphQL\\Field\\Page\\Fieldtype\\" . $field->type->className();
@@ -72,4 +72,4 @@ public static function getPageFields()
     ];
   }
 
-}
+}

src/Type/InterfaceType/PaginatedArrayType.php

@@ -68,7 +68,7 @@ public function resolveType($pageArray)
 
     // if there is only one template selected then we can assume it is a TemplatedPageArray
     if (count($templateSelector->values) === 1) {
-      $template = Utils::moduleConfig()->legalTemplates->get($templateSelector->values[0]);
+      $template = Utils::moduleConfig()->legalViewTemplates->get($templateSelector->values[0]);
       return new TemplatedPageArrayType($template);
     }
     return new PageArrayType();

src/Type/Object/PageImageType.php

@@ -5,7 +5,9 @@
 use Youshido\GraphQL\Type\Object\AbstractObjectType;
 use Youshido\GraphQL\Type\Scalar\StringType;
 use Youshido\GraphQL\Type\Scalar\IntType;
+use Youshido\GraphQL\Type\ListType\ListType;
 use ProcessWire\GraphQL\Type\InterfaceType\PageFileInterfaceType;
+use ProcessWire\GraphQL\Field\PageImage\PageImageSizeField;
 
 class PageImageType extends AbstractObjectType {
 
@@ -21,7 +23,7 @@ public function getDescription()
 
   public function build($config)
   {
-      
+
     $config->applyInterface(new PageFileInterfaceType());
 
     $config->addfield('width', [
@@ -39,11 +41,21 @@ public function build($config)
         return (integer) $value->height;
       }
     ]);
+
+    $config->addField('variations', [
+      'type' => new ListType(new PageImageType()),
+      'description' => 'Returns all size variations of the image.',
+      'resolve' => function ($value) {
+        return $value->getVariations();
+      }
+    ]);
+
+    $config->addField(new PageImageSizeField());
   }
 
   public function getInterfaces()
   {
     return [ new PageFileInterfaceType() ];
   }
 
-}
+}

src/Type/Object/TemplatedPageType.php

@@ -37,7 +37,7 @@ public function getDescription()
 
   public function build($config)
   {
-    $legalFields = Utils::moduleConfig()->legalFields;
+    $legalFields = Utils::moduleConfig()->legalViewFields;
     $config->applyInterface(new PageInterfaceType());
     foreach ($this->template->fields as $field) {
       if (!$legalFields->has($field)) continue;
@@ -53,4 +53,4 @@ public function getInterfaces()
       return [new PageInterfaceType()];
   }
 
-}
+}