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 3

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

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
  • Like 1
  • 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
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

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By horst
      Croppable Image 3
      for PW 3.0.20+
      Module Version 1.2.0
      Sponsored by http://dreikon.de/, many thanks Timo & Niko!
      You can get it in the modules directory!
      Please refer to the readme on github for instructions.
       
      - + - + - + - + - + - + - + - + - + - NEWS - 2020/03/19 - + - + - + - + - + - + - + - + - + - 
      There is a new Version in the pipe, that supports WebP too: 
       
      - + - + - + - + - + - + - + - + - + - NEWS - 2020/03/19 - + - + - + - + - + - + - + - + - + - 
       
       
      -------------------------------------------------------------------------
       
      Updating from prior versions:
       
      Updating from Croppable Image 3 with versions prior to 1.1.7, please do this as a one time step:
      In the PW Admin, go to side -> modules -> new, use "install via ClassName" and use CroppableImage3 for the Module Class Name. This will update your existing CroppableImage3 module sub directory, even if it is called a new install. After that, the module will be recogniced by the PW updater module, what makes it a lot easier on further updates.
      -------------------------------------------------------------------------
       
      For updating from the legacy Thumbnail / CropImage to CroppableImage3 read on here.
       
      -------------------------------------------------------------------------
       
    • By Robin S
      Inspired by a recent question.
      Image Crop Ratios
      Allows preset aspect ratios to be defined per image field for the ProcessWire image crop tool.
      The module adds a select dropdown to the crop tool. Choose an aspect ratio and the crop area will be fixed to that ratio.
      Screencast

      Installation
      Install the Image Crop Ratios module.
      Configuration
      Default aspect ratios for all image fields can be defined in the module config. Aspect ratios for specific image fields can be defined on the Input tab of the field settings. You can override the ratio settings in template context if needed. Insert a hyphen as the first item in the ratio settings unless you want to force a ratio to be applied to the crop tool. The hyphen represents a blank option that allows a free crop area to be drawn. Usage
      Click the "Crop" link on the details view of an image thumbnail. Click the "Crop" icon at the top of the editor window. Choose an option from the "Ratio" select dropdown.  
      https://github.com/Toutouwai/ImageCropRatios
      https://modules.processwire.com/modules/image-crop-ratios/
×
×
  • Create New...