Jump to content

Page Image Manipulator | API for 1 & 2


horst

Recommended Posts

Hey @sarah_hue, welcome to the forums and thanks for the kind words.

The recreation is forced by the optional second param of pimLoad. If you let it out or set it to false it takes the cached variation:

$imagewithwatermark = $img->pimLoad('tw'[, false] )-> ...

.
.
PS: viele Grüße in die Narrenhochburg Köln, Tätä!  :)

  • Like 2
Link to comment
Share on other sites

  • 2 weeks later...

Hi Horst, thanks so much for creating this module.

I have a question regarding page images that are set to allow multiple uploads per page, and which are placed into the body with CKEditor. Is there a method you would recommend for attacking each of these images, or would I be better off forcing my authors to use Hanna to place their images and tuck the image manipulation call in the hanna code?

Link to comment
Share on other sites

Okay, I've written a bit in Hanna Code editor, and I'm getting this error:

Exception: Cannot read the pngAlphaImageFile!

Now, if I echo the URL for the file I set as the watermark image, it's correct.

Is this error referring to the way my file was saved? I used Photoshop's Save for Web, PNG-24, with Transparency, convert to sRGB. Is there something else I ought to be doing? I checked your sample action but I don't see save settings, and it has too much styling for what I want to do (and I'm using a smaller-than-image watermark).

In case it's an error with my coding, here's my Hanna Code:

<?php

if(isset($img)) {
  $myImage = wire('page')->blog_images->eq($img);
  //echo $myImage->url;
} else {
  $myImage = wire('page')->blog_images->first();
  //echo $myImage->url;
}

if(isset($pos)) {
  // If the position is set, we're good
} else {
  // otherwise we make sure the position is set to the default.
  $pos = 'SE';
}

if(isset($pad)) {
  // If the padding is set, we're good
} else {
  // otherwise we make sure the padding is set to the default.
  $pad = '2';
}

$username = wire('user')->name;
$AlphaImageUser = "{$config->urls->assets}images/authorwmk/swmb-{$username}.png";
// echo $AlphaImageUser;
$pngAlphaImage = $AlphaImageUser;

if($myImage != '') { 
    // Here's where the PageImageManipulator watermark code goes
    $imgsrc = $myImage->pimLoad('SwMb')->watermarkLogo($pngAlphaImage, $position=$pos, $padding=$pad);  // **this is the line triggering the error
    $newimg = $imgsrc->height(400)->url;
    echo $newimg;
    echo "<a href='{$imgsrc->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{wire('page')->title}' /></a>";
    echo "<p><small>{$myImage->description}</small></p>";
}
Link to comment
Share on other sites

Hey, I think you simply need to respect the scope here in Line 26:

$config->urls->assets ...

 Try it with:

wire("config")->urls->assets
$AlphaImageUser = wire("config")->urls->assets . "images/authorwmk/swmb-{$username}.png";
Edited by horst
Link to comment
Share on other sites

wire("config")->urls->assets
$AlphaImageUser = wire("config")->urls->assets . "images/authorwmk/swmb-{$username}.png";

Thanks for the quick reply. Unfortunately this results in no change. The echo of $AlphaImageUser is the same for both wire("config")->... and $config->... (and both result in the correct path).

Link to comment
Share on other sites

Ah, sorry. I'm in hurry. Haven't read thoroughly.

So, 24 bit photoshop png should be fine. The error is triggered here: https://github.com/horst-n/PageImageManipulator/blob/master/ImageManipulator.class.php#L1651

It is only triggered when the file isn't existing or isn't readable: https://github.com/horst-n/PageImageManipulator/blob/master/ImageManipulator.class.php#L2437

It has nothing todo with the PNG type at this point here.

Are you sure the filename is correct?

You can test it in your code here before passing it to the pim:

echo "<pre>" . $AlphaImageUser . "\n";
echo realpath($AlphaImageUser) . "\n";
echo (is_readable(realpath($AlphaImageUser)) ? 'is readable' : 'UHM, is NOT readable!') . "\n</pre>";
Link to comment
Share on other sites

Thanks! I am getting the 'UHM' version, though I'm not sure why.

The results are:

/swatchmob/site/assets/images/authorwmk/swmb-mls.png

UHM, is NOT readable!

But the image does exist at http://www.creativejay.com/swatchmob/site/assets/images/authorwmk/swmb-mls.png so I'm really not sure what makes this path unreadable.

Edited to add: I had the same problem if I called the URL from an image field (on the user's profile) as the PNG source, as well.

Link to comment
Share on other sites

Oh, so does you have differences between your path and the output from realpath:

echo "<pre>" . $AlphaImageUser . "\n";
echo realpath($AlphaImageUser) . "\n";

??

..., and what does it say here with this tests:

echo "<pre>with realpath:\n";

// test with realpath
echo (file_exists(realpath($AlphaImageUser)) ? 'file exists' : 'file do NOT exist!') . "\n;
echo (is_readable(realpath($AlphaImageUser)) ? 'is readable' : 'UHM, is NOT readable!') . "\n";

// test without realpath
echo "\nwithout realpath:\n";

echo (file_exists($AlphaImageUser) ? 'file exists' : 'file do NOT exist!') . "\n;
echo (is_readable($AlphaImageUser) ? 'is readable' : 'UHM, is NOT readable!') . "\n";

echo "</pre>";
Link to comment
Share on other sites

with realpath:file do NOT exist!UHM, is NOT readable!without realpath:file do NOT exist!UHM, is NOT readable!

As you saw, there's a path associated in the case of "without realpath" and "with realpath" outputs nothing.

Sorry to lean on you heavily for this, I've never encountered this problem before.

Link to comment
Share on other sites

AH, it says file does not exist!!!

So, we have to use path instead of url, I think. :lol:

// not ->urls
$AlphaImageUser = "{$config->urls->assets}images/authorwmk/swmb-{$username}.png";

// but ->paths
$AlphaImageUser = "{$config->paths->assets}images/authorwmk/swmb-{$username}.png";
  • Like 1
Link to comment
Share on other sites

That solves the missing image.

Unfortunately there's a new error now..  :o

with realpath:/home/creative/public_html/swatchmob/site/assets/images/authorwmk/swmb-mls.pngfile existsis readablewithout realpath:/home/creative/public_html/swatchmob/site/assets/images/authorwmk/swmb-mls.pngfile existsis readable

Error: Maximum execution time of 60 seconds exceeded (line 41 of /home/creative/public_html/swatchmob/wire/core/WireData.php)
This error message was shown because you are logged in as a Superuser. Error has been logged.

Link to comment
Share on other sites

According to my host, my server has a minimum "Dual 5530 Gainstown processors with 8 cores, RAID-10 protected hard disk space, and 8 GB of RAM."

I can increase my max_execution_time in the .ini so that it hopefully has time to run. I just have to find the right folder(s) to put the .ini in. Tried to change it in /.htaccess with no success.

Default is to cache these files, right? :lol:

Link to comment
Share on other sites

I've got it running but it's painfully slow on every page load, not just the first. I built a manual check for the resized image into my HannaCode to speed it up. That made a huge difference, even though I thought PIM checks for the file before it starts. Or maybe, as usual, it's me.

Can you tell me what about the following code seems to be forcing the image to re-create every time?

<?php
if(wire('page')->template = 'blog-post') {
  $width = '375';
  $myImage = wire('page')->blog_images->eq($img);
  if($myImage->description) {$alt = $myImage->description;}
  
  if($on='Y') {
	$pimImg = $config->paths->files . wire('page')->id . "/" . "pim_swmb_" . $myImage->width($width)->name;
    $pimImgBig = $config->paths->files . wire('page')->id . "/" . "pim_swmb_" . $myImage->name;
    echo $pimImg;
    if(file_exists($pimImg)) { 
        $wmkImg = $config->urls->files . wire('page')->id . "/" . "pim_swmb_" . $myImage->width($width)->name;
        $wmkImgBig = $config->urls->files . wire('page')->id . "/" . "pim_swmb_" . $myImage->name;
        echo "<a href='{$wmkImgBig}' title='Click for Full Size' /><img src='{$wmkImg}' class='align_center' alt='{$alt}' /></a><p><small>{$alt}</small></p>";
    } else { 
    $username = wire('page')->createdUser->name;
	$AlphaImageUser = "{$config->paths->assets}images/authorwmk/swmb-{$username}.png";
	$pngAlphaImage = $AlphaImageUser;
	$imgsrc = $myImage->pimLoad("SwMb", false)->watermarkLogo($pngAlphaImage, $position=$pos, $padding=$pad)->pimSave();
    // output image
    $newimg = $imgsrc->width($width)->url;
	echo "<a href='{$imgsrc->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{$alt}' /></a><p><small>{$alt}</small></p>";
	}
} else {
	$newimg = $myImage->width($width)->url;
	echo "<a href='{$myImage->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{$alt}' /></a><p><small>{$alt}</small></p>"; 
}
}

Thanks again!

Link to comment
Share on other sites

Hi Soma, thanks for reading it over!

Strange code you have here, not really getting what you doing there manually creating img path etc.

But this condition will always be true.

if($on='Y') {

As I mentioned, it seemed like Page Image Manipulator was making the images fresh each time the page loaded (with no changes to HannaCode or the page images field), so I was trying to test that theory, and also speed up the page load (which it has).

$on is a variable that I wanted to provide for the page author, so that if the image already has a watermark, or if it was sourced from another creator, we wouldn't watermark the image. is $on something global I'm not aware of? I can easily change that name.

This will also be always true:

  1. if(wire('page')->template = 'blog-post') {

I added that because on my home page (of template swmb-home) I was getting an error that I was trying to get eq() on a non object. Adding that line fixed it.

Link to comment
Share on other sites

@creativejay - what Soma is getting at is that in PHP (and many other coding languages, maybe all ?) a single equals sign does not check if one thing equals the other, but rather makes it equal. So even though you have the if(), that line is always setting $on to "Y".

You need to use two equals signs, eg:

if($on=='Y') {

In some situations you even want to make use of three. Here is a useful discussion on the differences:

http://stackoverflow.com/questions/2063480/the-3-different-equals

Link to comment
Share on other sites

Ah! Thank you for rubbing my nose in it, adrian. I would claim to know the difference, but then I do things like that. And worse, don't spot them after.

My question does remain, though. Any idea why PIM seems to re-process the image on every page load unless I check for the file and skip it manually?

<?php
if(wire('page')->template == 'blog-post') {
    // lay some ground rules
  $width = '375';
  $myImage = wire('page')->blog_images->eq($img);
  $prfix = 'swatchmob';
  if($myImage->description) {$alt = $myImage->description;}
    // check if the watermark is needed
  if($on =='Y') {
    // check if the watermark exists already
    $pimImg = $config->paths->files . wire('page')->id . "/" . "pim_" . $prfix . "_" . $myImage->width($width)->name;
    $pimImgBig = $config->paths->files . wire('page')->id . "/" . "pim_" . $prfix . "_" . $myImage->name;
    if(file_exists($pimImg)) {
        $wmkImg = $config->urls->files . wire('page')->id . "/" . "pim_" . $prfix . "_" . $myImage->width($width)->name;
        $wmkImgBig = $config->urls->files . wire('page')->id . "/" . "pim_" . $prfix . "_" . $myImage->name;
        echo "<a href='{$wmkImgBig}' title='Click for Full Size' /><img src='{$wmkImg}' class='align_center' alt='{$alt}' /></a>";
    } else {
    // build the file with the watermark
    $username = wire('page')->createdUser->name;
    $AlphaImageUser = "{$config->paths->assets}images/authorwmk/swmb-{$username}.png";
    $pngAlphaImage = $AlphaImageUser;
    $imgsrc = $myImage->pimLoad($prfix, false)->watermarkLogo($pngAlphaImage, $position=$pos, $padding=$pad)->pimSave();
    // output image
    $newimg = $imgsrc->width($width)->url;
    echo "<a href='{$imgsrc->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{$alt}' /></a>";
    }
} else {
    $newimg = $myImage->width($width)->url;
    echo "<a href='{$myImage->url}' title='Click for Full Size' /><img src='{$newimg}' class='align_center' alt='{$alt}' /></a>";
}
if($alt) { echo "<p><small>{$alt}</small></p>"; }
}
Edited by creativejay
Link to comment
Share on other sites

Ah! Thank you for rubbing my nose in it, adrian. I would claim to know the difference, but then I do things like that. And worse, don't spot them after.

That wasn't my intention at all :) We have all fallen victim to this one - several times!

I don't ever remember to do it, but it is why it is recommended to do:

f("Y"==$on){

With it reversed like that, if you forget the second equals sign, it will throw an error, rather than assigning the value!

Link to comment
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 monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      FieldtypeQRCode
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      A simple fieldtype generating a QR Code from the public URL of the page, and more.
      Using the PHP library QR Code Generator by Kazuhiko Arase.

      Options
      In the field’s Details tab you can change between .gif or .svg formats. If you select .svg you will have the option to directly output the markup instead of a base64 image. SVG is the default.
      You can also change what is used to generate the QR code and even have several sources. The accepted sources (separated by a comma) are: httpUrl, editUrl, or the name of any text/URL/file/image field.
      If LanguageSupport is installed the compatible sources (httpUrl, text field, ...) will return as many QR codes as there are languages. Note however that when outputting on the front-end, only the languages visible to the user will be generated.
      Formatting
      Unformatted value
      When using $page->getUnformatted("qrcode_field") it returns an array with the following structure:
      [ [ "label" => string, // label used in the admin "qr" => string, // the qrcode image "source" => string, // the source, as defined in the configuration "text" => string // and the text used to generate the qrcode ], ... ] Formatted value
      The formatted value is an <img>/<svg> (or several right next to each other). There is no other markup.
      Should you need the same markup as in the admin you could use:
      $field = $fields->get("qrcode_field"); $field->type->markupValue($page, $field, $page->getUnformatted("qrcode_field")); But it’s a bit cumbersome, plus you need to import the FieldtypeQRCode's css/js. Best is to make your own markup using the unformatted value.
      Static QR code generator
      You can call FieldtypeQRCode::generateQRCode to generate any QR code you want. Its arguments are:
      string $text bool $svg Generate the QR code as svg instead of gif ? (default=true) bool $markup If svg, output its markup instead of a base64 ? (default=false) Hooks
      Please have a look at the source code for more details about the hookable functions.
      Examples
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $page = $event->arguments("page"); $event->return = $page->title; // or could be: $event->return = "Your custom text"; }) $wire->addHookAfter("FieldtypeQRCode::generateQRCodes", function($event) { $qrcodes = $event->return; // keep everything except the QR codes generated from editUrl foreach($qrcodes as $key => &$qrcode) { if($qrcode["source"] === "editUrl") { unset($qrcodes[$key]); } } unset($qrcode); $event->return = $qrcodes; })
    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      Features
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
×
×
  • Create New...