Jump to content
thomasaull

Module: RestApi

Recommended Posts

Hi, how do i get multiple images when i query the API?

 

My code:

    public static function getPage($data) {
        $data = RestApiHelper::checkAndSanitizeRequiredParameters($data, ['id|int']);

        $response = new \StdClass();
        $p = wire('pages')->get($data->id);

        if(!$p->id) throw new \Exception('Page not found');

        $response->id = $p->id;
        $response->name = $p->name;
        $response->title = $p->title->getLanguageValue('default');
        $response->body = $p->body->getLanguageValue('default');
        $response->sidebar = $p->sidebar->getLanguageValue('default');
        $response->summary = $p->summary->getLanguageValue('default');
        $response->images = $p->images;

        return $response;
    }

My response now:

{
    "id": 1002,
    "name": "child-page-example-1",
    "title": "Child page example 1",
    "body": "<h2>Ut capio feugiat saepius torqueo olim</h2>\n\n<h3>In utinam facilisi eum vicis feugait nimis</h3>\n\n<p>Iusto incassum appellatio cui macto genitus vel. Lobortis aliquam luctus, roto enim, imputo wisi tamen. Ratis odio, genitus acsi, neo illum consequat consectetuer ut.</p>\n\n<blockquote>\n<p>Wisi fere virtus cogo, ex ut vel nullus similis vel iusto. Tation incassum adsum in, quibus capto premo diam suscipere facilisi. Uxor laoreet mos capio premo feugait ille et. Pecus abigo immitto epulae duis vel. Neque causa, indoles verto, decet ingenium dignissim.</p>\n</blockquote>\n\n<p>Patria iriure vel vel autem proprius indoles ille sit. Tation blandit refoveo, accumsan ut ulciscor lucidus inhibeo capto aptent opes, foras.</p>\n\n<h3>Dolore ea valde refero feugait utinam luctus</h3>\n\n<p>Usitas, nostrud transverbero, in, amet, nostrud ad. Ex feugiat opto diam os aliquam regula lobortis dolore ut ut quadrum. Esse eu quis nunc jugis iriure volutpat wisi, fere blandit inhibeo melior, hendrerit, saluto velit. Eu bene ideo dignissim delenit accumsan nunc. Usitas ille autem camur consequat typicus feugait elit ex accumsan nutus accumsan nimis pagus, occuro. Immitto populus, qui feugiat opto pneum letalis paratus. Mara conventio torqueo nibh caecus abigo sit eum brevitas. Populus, duis ex quae exerci hendrerit, si antehabeo nobis, consequat ea praemitto zelus.</p>\n\n<p>Immitto os ratis euismod conventio erat jus caecus sudo. code test Appellatio consequat, et ibidem ludus nulla dolor augue abdo tego euismod plaga lenis. Sit at nimis venio venio tego os et pecus enim pneum magna nobis ad pneum. Saepius turpis probo refero molior nonummy aliquam neque appellatio jus luctus acsi. Ulciscor refero pagus imputo eu refoveo valetudo duis dolore usitas. Consequat suscipere quod torqueo ratis ullamcorper, dolore lenis, letalis quia quadrum plaga minim.</p>",
    "sidebar": "<h3>Sudo nullus</h3>\n\n<p>Et torqueo vulpes vereor luctus augue quod consectetuer antehabeo causa patria tation ex plaga ut. Abluo delenit wisi iriure eros feugiat probo nisl aliquip nisl, patria. Antehabeo esse camur nisl modo utinam. Sudo nullus ventosus ibidem facilisis saepius eum sino pneum, vicis odio voco opto.</p>",
    "summary": "Dolore ea valde refero feugait utinam luctus. Probo velit commoveo et, delenit praesent, suscipit zelus, hendrerit zelus illum facilisi, regula. ",
    "images": [
        {}
    ]
}

Thanks for the great module!

Share this post


Link to post
Share on other sites

Hi @gottberg

There is a bit of work to get images, as the way you are doing return Images Objects and not array. You can have a look at this file to see the "complexity" to retrieve those objects :

https://github.com/microcipcip/processvue/blob/master/site-processvue/templates/inc/pagefields.php#L236

 

Or you can build your own images array before assigning it to the API answer :

 

See updated ImageHelper.php file at the bottom of this post.

 

/* 
route :  
'page' => [
    ['GET', '{id:\d+}', Example::class, 'getPage', ["auth" => false]]
  ]
*/

// get page route answer function
public static function getPage($data)
  {
    $data = RestApiHelper::checkAndSanitizeRequiredParameters($data, ['id|int']);

    $response = new \StdClass();
    $p = wire('pages')->get($data->id);

    if(!$p ->id) throw new \Exception('Page not found');

    $response->id = $p->id;
    $response->name = $p->name;
    $response->title = $p->title;
    $response->body = $p->body;
    $response->sidebar = $p->sidebar;
    $response->summary = $p->summary;

	// our own images array
    $images = array();
    foreach ($p->images as $image) {
      array_push($images, array(
        $image->name => array(
            'url'  => $image->url,
            'filename' => $image->filename,
            'width' => $image->width,
            'height' => $image->height
			// ...
          )
        )
      );
    }
    $response->images = $images;

    return $response;
  }

 

Result :

41790518_Capturedecran2019-02-23a11_11_55.thumb.png.3fc4c290c11102c927dd4ff7c9068bec.png

 

---

 

Edit :

The image class helper :

<?php namespace ProcessWire;

/**
 * InputfieldImage Helper
 * Use for single image
 * 
 * Usage :
 *  $image is your ProcessWire PageImage
 *  return ImageHelper::get($image, [400, 800, 1200, 2000, 2500]);
 */

class ImageHelper {
  public static function get ($image, $widths = [400, 800, 1200]) {
    $response = new \StdClass();
    $response->focus = ["x" => $image->focus['left'], "y" => $image->focus['top']];
    $response->urls = [];
    $response->description = $image->description;
    $response->name = $image->basename;
    $response->width = $image->width;
    $response->height = $image->height;

    foreach ($widths as $width) {
      $croppedImage = $image->width($width);

      $url = new \StdClass();
      $url->url = $croppedImage->httpUrl;
      $url->width = $croppedImage->width;
      $url->height = $croppedImage->height;
      $url->ratio = $croppedImage->height / $croppedImage->width;

      array_push($response->urls, $url);
    }

    return $response;
  }
}


/**
 * InputfieldImage Helper
 * Use for multiple images
 * 
 * Usage :
 *  $images is your ProcessWire PageImages
 *  return ImagesHelper::get($images, [400, 800, 1200, 2000, 2500]);
 */

class ImagesHelper {
  public static function get($images, $widths = [400, 800, 1200]) {
    $response = new \StdClass();
    $response->images = [];
    $img = new \StdClass();

    // our own images array
    $imagesArr = array();
    foreach ($images as $image) {
      $img->focus = ["x" => $image->focus['left'], "y" => $image->focus['top']];
      $img->urls = [];
      $img->description = $image->description;
      $img->name = $image->basename;
      $img->width = $image->width;
      $img->height = $image->height;

      foreach ($widths as $width) {
        $croppedImage = $image->width($width);

        $url = new \StdClass();
        $url->url = $croppedImage->httpUrl;
        $url->width = $croppedImage->width;
        $url->height = $croppedImage->height;
        $url->ratio = $croppedImage->height / $croppedImage->width;

        array_push($img->urls, $url);
      }

      array_push($response->images, $img);
    }

    return $response;
  }
}

 

Edited by flydev
Code - ImageHelper Class
  • Like 2

Share this post


Link to post
Share on other sites
On 12/5/2018 at 12:53 PM, eelkenet said:

I ran into an issue that is related to the way the RestAPI circumvents the pagetree structure (running the checkIfApiRequest hook before rendering any page).
This method made it impossible to use ProCache for API requests that could (and should) return a cached result, such as for static site content. I thought about creating a custom caching system on top of RestApi, but ProCache is just too well designed to ignore here.   

 I wrote a post about this on the ProCache VIP-forum, but as this forum is not accessible to all people I'd like to share my (admittedly hacky) solution for this. Basically I add another (cacheable) endpoint in the pagetree, which pipes the request to the RestApi endpoint: 

  1. Create a new template and corresponding page (I called both 'api'). 
  2. Set the content-type of this template to application/json, and disable any prepending/appending of files.  
  3. Add the following code to the template: 

<?php //site/templates/api.php

$protocol = $config->https ? "https://" : "http://";
$endpoint = $modules->get("RestApi")->endpoint;
$hostname = $config->httpHost;
$segments = implode("/", $input->urlSegments);
$url =  $protocol.$hostname."/".$endpoint.$segments;

return file_get_contents($url);

I'm sure there would be a better, cleaner way of doing this. A current downside is that there now are 2 seemingly identical endpoints for my site.
One is cached, and the other is 'live'.  

Any ideas?

@eelkenet I'm sorry, somehow I missed your post. Do you think there is any way I can support ProCache with the module itself? I could also use a page in the pagetree to deliver the endpoint instead of doing it with a Hook

  • Like 2

Share this post


Link to post
Share on other sites

@gottberg @flydev I created a small helper class for dealing with responsive images:

<?php namespace ProcessWire;

class Image {
  public static function get ($image, $widths = [400, 800, 1200]) {
    $response = new \StdClass();
    $response->focus = ["x" => $image->focus['left'], "y" => $image->focus['top']];
    $response->urls = [];
    $response->description = $image->description;
    $response->name = $image->basename;
    $response->width = $image->width;
    $response->height = $image->height;

    foreach ($widths as $width) {
      $croppedImage = $image->width($width);

      $url = new \StdClass();
      $url->url = $croppedImage->httpUrl;
      $url->width = $croppedImage->width;
      $url->height = $croppedImage->height;
      $url->ratio = $croppedImage->height / $croppedImage->width;

      array_push($response->urls, $url);
    }

    return $response;
  }
}

Usage:

// $image is your ProcessWire PageImage
return Image::get($image, [400, 800, 1200, 2000, 2500]);

 

  • Like 1
  • Thanks 2

Share this post


Link to post
Share on other sites
7 hours ago, thomasaull said:

@eelkenet I could also use a page in the pagetree to deliver the endpoint instead of doing it with a Hook

Hi @thomas, no problem. And yes, definitely! I think that would be much better.
Anything that comes from inside the regular page rendering can be cached with ProCache.

  • Like 2

Share this post


Link to post
Share on other sites
On 2/25/2019 at 5:19 PM, eelkenet said:

Hi @thomas, no problem. And yes, definitely! I think that would be much better.
Anything that comes from inside the regular page rendering can be cached with ProCache. 

It might be a good idea to make this configurable, so the user can choose between a webhook or select a page to act as the api endpoint. You wanna provide a PR @eelkenet? I'm a bit short of time currently.

Share this post


Link to post
Share on other sites

@thomasaull 

I noticed something annoying in the API endpoint config field, I need to open the devtools and remove the `pattern` attribute manually in order to save the settings, look :

 

restapi-regex.gif.86ba4f74ef03cb663470e8b9f0b4cdf2.gif

 

If you are short on time, I can send a PR.

Share this post


Link to post
Share on other sites
On 2/28/2019 at 2:58 PM, thomasaull said:

It might be a good idea to make this configurable, so the user can choose between a webhook or select a page to act as the api endpoint. You wanna provide a PR @eelkenet? I'm a bit short of time currently.

I'm sorry @thomasaull, but I don't believe I understand the module's inner workings well enough to pull that off 😕

Here is the final cleaned-up and more secure 'api' template that I am using in between the RestApi router and ProCache, perhaps it can be of some help:

Edit: check this reply for an updated version:

 

Share this post


Link to post
Share on other sites

Hey Thomas,

I had some issues yesterday with the jwt-authorization. On a local development server (vagrant, ubuntu, apache). The authorization headers were empty. Therefore the getAuthorizationHeader method in Router.php returned null and the token was not returned. I made a small modification to the method and it works for me. Perhaps it is not the cleanest way, but it's ok for now. Just to let you know.

 

// apache
if (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') !== false) {
	foreach (apache_request_headers() as $key => $value) {
		$headers[strtolower($key)] = $value;
	}
}
else {
	foreach ($_SERVER as $key => $value) {
		$headers[strtolower($key)] = $value;
	}
}

 

Share this post


Link to post
Share on other sites

@pmichaelis Is vagrant using an apache or nginx server? Can you check where the authorization header is contained in your case (apache_request_headers or $_SERVER)? And what version of php are you using?

Share this post


Link to post
Share on other sites
Posted (edited)

For my project I need an implementation of Basic Auth, so I added a new option 'Basic Auth' available in the module config :

513778484_Capturedecran2019-03-01a15_46_33.png.953386b31c415f513c8ede1a0db25cd2.png

 

and then, in the Router.php file, method handle(), I added the following code :

// Basic HTTP Authentication
    if($authMethod === 'basic' && $routeNeedsAuth) {
      $authHeader = self::getAuthorizationHeader();
      if(!$authHeader) {
        self::displayError('Bad Request', 400);
      }
      
      $hash = base64_decode(substr($_SERVER["HTTP_AUTHORIZATION"], 6)) ;
      $authHeader = explode(':', $hash, 2);
      if(!isset($authHeader[0]) || !isset($authHeader[1])) {
        self::displayError('No Authorization Header found', 400);
      }

      $credentials = new \StdClass();
      $credentials->user = $authHeader[0];
      $credentials->pass = $authHeader[1];

      RestApiHelper::checkAndSanitizeRequiredParameters($credentials, ['user|selectorValue', 'pass|text']);
      $loggedin = wire('session')->login($credentials->user, $credentials->pass);
      if(!$loggedin) {
        self::displayError('user does not have authorization', 401);
      }
    }

 

and in the method getAuthorizationHeader() I added :

if(array_key_exists('php_auth_user', $headers)) return ['user' => $headers['php_auth_user'], 'pass' => $headers['php_auth_pw']];

 

basic-auth.gif.b6f37977610260df0b98b23cfb002d8c.gif

 

It works, but does it make sense ?

 

Edit: 

Pull Request https://github.com/thomasaull/RestApi/pull/3

 

Edited by flydev
GitHub Pull Request
  • Thanks 1

Share this post


Link to post
Share on other sites

@thomasaull @pmichaelis We had similar issues with the Authorization-header, depending on the server's configuration. In our case, adding the following `RewriteRule` to the .htaccess-file solved the problems:

RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

 

Share this post


Link to post
Share on other sites

Is there any example, how to use for posting a new page?
Example: axios.put("/api/post" ...

Share this post


Link to post
Share on other sites

@flydev Thanks for your PR. I'm going to investigate (feel free to remind me, if you don't hear back)! One concern though, do you think it's a good practice to send the password on every request? In this case you'd have to store the password somewhere in your frontend, which I think is security bad practise. Maybe other people do have an opinion about that?

  • Thanks 1

Share this post


Link to post
Share on other sites

@Sebi@pmichaelis Think I'm going to include @pmichaelis since it does not required additional configuration (actually before I used the RestApi Module with NGINX it was using apache_request_headers anyway)

  • Thanks 1

Share this post


Link to post
Share on other sites
3 hours ago, siilak said:

Is there any example, how to use for posting a new page?
Example: axios.put("/api/post" ... 

@siilak I think all you need to do is to add your route in Routes.php:

$routes = [
  ['PUT', 'user', User::class, 'addUser'],
];

And have some functionality for adding your data in your 'addUser' Function.

Let me know, if it works!

Share this post


Link to post
Share on other sites
Posted (edited)
1 hour ago, thomasaull said:

One concern though, do you think it's a good practice to send the password on every request?

If used with HTTPS, "I don't see it" as a security hole that way. Anyway, the question is legit and could lead to his own post in the security section following by bad/good practices, it also depend on the scenario you are in. If a security token is intercepted, you're screwed up, if the login/password is intercepted, same here and cookies will be eat. The password could be weak and guessed but already a bit restricted in the current version of ProcessWire and can be configured to be stronger. SSL/TLS 0-day ? it's not happening everyday.. but it happen. As always, security.... its also about people "education"..

The only real drawback I see, is that imagine 3 months later after a valid authentication, a token would be invalid, but the user/login should be still valid. Another scenario possible here but the issue could be tackled.

References:

 

Meanwhile maybe @LostKobrakai will have a good comment about that.

Edited by flydev
refs

Share this post


Link to post
Share on other sites

@flydev For http basic auth I'd only use user/password for initial logins and for any subsequent request use some kind of token. Generally I'd support what you said about tls and intercepted requests holding any information be it a password or token, but I think more important is the fact that a user won't insert a password for each request and you don't want your app to somehow cache the supplied password. That's what should never be promoted.

  • Like 2

Share this post


Link to post
Share on other sites
15 hours ago, thomasaull said:

@Sebi@pmichaelis Think I'm going to include @pmichaelis since it does not required additional configuration (actually before I used the RestApi Module with NGINX it was using apache_request_headers anyway)

That's fine. In our case it was necessary to explicitly add the line in the .htaccess-file, but that should be the last solution if everything else fails. 

We already had a similar solution like @pmichaelis's code example to use $_SERVER if apache_request_headers fails. Maybe its more save to check for the function 'apache_request_headers' to exist:

if(function_exists("apache_request_headers")) {

 

  • Thanks 1

Share this post


Link to post
Share on other sites

User registration example:

public static function addUser($data) {
    RestApiHelper::checkAndSanitizeRequiredParameters($data, [
      'username|selectorValue',
      'password|string',
      'email|text',
    ]);

    $item = new User();
    $item->setOutputFormatting(false);
    $item->name = $data->username;
    $item->pass = $data->password;
    $item->email = $data->email;
    $item->addRole('guest');
    $item->save();
    
}

 

  • Like 2

Share this post


Link to post
Share on other sites

The jwt auth mechanism is producing errros on a live system.
I allready looked for "Wrong number of segments", installed the module again, but the error is still there.  Any hints on that?

DATUM/ZEIT BENUTZER URL TEXT
vor 2 Minuten
2019-03-29 13:22:58
api /api/v1/items Error: Exception: Wrong number of segments (in /cms/site/modules/RestApi/Router.php line 131). File: /cms/index.php:64

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By gebeer
      Although the PW backend is really intuitive, ever so often my clients need some assistance. Be it they are not so tech savvy or they are not working in the backend often.
      For those cases it is nice to make some help videos available to editors. This is what this module does.
      ProcessHelpVideos Module
      A Process module to display help videos for the ProcessWire CMS. It can be used to make help videos (screencasts) available to content editors.
      This module adds a 'Help Videos" section to the ProcessWire backend. The help videos are accessible through an automatically created page in the Admin page tree. You can add your help videos as pages in the page tree. The module adds a hidden page to the page tree that acts as parent page for the help video pages. All necessary fields and templates will be installed automatically. If there are already a CKEditor field and/or a file field for mp4 files installed in the system, the module will use those. Otherwise it will create the necessary fields. Also the necessary templates for the parent help videos page and it's children are created on module install. The module installs a permission process-helpvideos. Every user role that should have access to the help video section, needs this permission. I use the help video approach on quite a few production sites. It is stable so far and well received by site owners/editors. Up until now I installed required fields, templates and pages manually and then added the module. Now I added all this logic to the install method of the module and it should be ready to share.
      The module and further description on how to use it is available on github: https://github.com/gebeer/ProcessHelpVideos
      If you like to give it a try, I am happy to receive your comments/suggestions here.
    • By Robin S
      A module created in response to the topic here:
      Page List Select Multiple Quickly
      Modifies PageListSelectMultiple to allow you to select multiple pages without the tree closing every time you select a page.
      The screencast says it all:

       
      https://github.com/Toutouwai/PageListSelectMultipleQuickly
      https://modules.processwire.com/modules/page-list-select-multiple-quickly/
    • By gebeer
      Hello all,
      sharing my new module FieldtypeImagePicker. It provides a configurable input field for choosing any type of image from a predefined folder.
      The need for it came up because a client had a custom SVG icon set and I wanted the editors to be able to choose an icon in the page editor.
      It can also be used to offer a choice of images that are used site-wide without having to upload them to individual pages.
      There are no image manipulation methods like with the native PW image field.
      Module and full description can be found on github https://github.com/gebeer/FieldtypeImagePicker
      Kudos to @Martijn Geerts. I used his module FieldTypeSelectFile as a base to build upon.
      Here's how the input field looks like in the page editor:

      Hope it can be of use to someone.
      If you like to give it a try, I'm happy to hear your comments or suggestions for improvement. Eventually this will go in the module directory soon, too.
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Modules Directory: https://modules.processwire.com/modules/rock-pdf/
      Download & Docs: https://github.com/BernhardBaumrock/RockPDF
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread:
       
    • By ukyo
      FieldtypeFontIconPicker
      Supported Icon Libraries
      FontAwesome 4.7.0 Uikit 3.0.34 IonicIcons 2.0.1 Cahangelog
      NOTE: Module store data without prefix, you need to add "prefix" when you want to show your icon on front-end, because some of front-end frameworks using font-awesome with different "prefix".
      Module will search site/modules/**/configs/IconPicker.*.php and site/templates/IconPicker.*.php paths for FieldtypeFontIconPicker config files.
      All config files need to return a PHP ARRAY like examples.
      Example config file : create your own icon set.
      File location is site/configs/IconPicker.example.php
      <?php namespace ProcessWire; /** * IconPicker : Custom Icons */ return [ "name" => "my-custom-icons", "title" => "My Custom Icon Set", "version" => "1.0.0", "styles" => array( wire("config")->urls->templates . "dist/css/my-custom-icons.css" ), "scripts" => array( wire("config")->urls->templates . "dist/js/my-custom-icons.js" ), "categorized" => true, "attributes" => array(), "icons" => array( "brand-icons" => array( "title" => "Brand Icons", "icons" => array( "google", "facebook", "twitter", "instagram" ) ), "flag-icons" => array( "title" => "Flag Icons", "icons" => array( "tr", "gb", "us", "it", "de", "nl", "fr" ) ) ) ]; Example config file : use existing and extend it.
      File location is site/configs/IconPicker.altivebir.php
      <?php namespace ProcessWire; /** * IconPicker : Existing & Extend */ $resource = include wire("config")->paths->siteModules . "FieldtypeFontIconPicker/configs/IconPicker.uikit.php"; $url = wire("config")->urls->templates . "dist"; $resource["scripts"] = array_merge($resource["scripts"], ["{$url}/js/Altivebir.Icon.min.js"]); $resource["icons"]["flag-icons"] = [ "title" => "Flag Icons", "icons" => array("tr", "en", "fr", "us", "it", "de") ]; $resource["icons"]["brand-icons"]["icons"] = array_merge($resource["icons"]["brand-icons"]["icons"], array( "altivebir" )); return $resource; After you add your custom config file, you will see your config file on library select box. Library Title (Location Folder Name).

      If your library categorized and if you have categorized icons set like uikit and fontawesome libraries, you will have category limitation options per icon field or leave it empty for allow all categories (default).

      Example : output
      if ($icon = $page->get("iconField")) { echo "<i class='prefix-{$icon}' />"; } MarkupFontIconPicker Usage
      // MarkupFontIconPicker::render(YourIconField=string, Options=array) echo MarkupFontIconPicker::render($page->YourIconField, [ 'prefix' => 'uk-icon-', // Icon class prefix, if you have different prefix, default is : "fa fa-" 'tag' => 'span', // Icon tag default is : "i" 'class' => 'fa-lg', // If you have extra cutom classes, for example : icons sizes, Array or Sting value 'style' => 'your custom styles if you have' // Array or String Value ]); Theme support

      Search support

      Category support

       
×
×
  • Create New...