Jump to content

Images Manager (beta)


Soma

Recommended Posts

PW Images Manager (beta)

Just a weird little screencast trying to show how it works. (out of date a little, tags now use a textfield for easy copy/paste)

This module allows you to manage images from one central repository. You create a root page "/images/" where you can then add categories and images as pages. From there the new admin page created "ImagesManager" will show categories and images added in a ajax data table, from where you can see and search/filter all images, upload and create new categories and edit images too.

Every image will also show an image tag generated to copy into a textarea. This tag looks like this:

{image=/path/to/image/imagename/, width=200}
The width=100 is the thumbnail size used to output the image.

You can also have additional segment to contain classes:

{image=/path/to/image/imagename/, width=100, class=align_left}
Or you can enter the id directly:
{image=1033, width=100}
Once inserted into a textarea field it will get parsed when saved and loaded automaticly. It will store an abstract id tag in Database and convert it back to the image HTML tag. So after first save you'll see the image inserted in a Wysiwyg and be able to resize and place it as usual. Once it's inserted somewhere Images Manager will show a search link with the pages containing the image (you can configure the fields int the module setting). You can change the image or move it to a different category, it will still work and show the correct image. This also works with multi-language fields.

You can still also use the regular insert image dialog in TinyMCE and chose image from those pages. And it will start keeping track of those as well (they're the same after all).

You can use those central images pages also with page fields to reference them single or even whole categories, search them with API and do what you like.

Images Manager will also parse the page render on front-end and replace any found image tags with the HTML code. It will also look for a description on the image and output it as alt tag. If you want to have multi-language description you can add a `image_description` TextLanguage field to the image page template and have images parser use them.

Along with this module, you can also install the `PageListImageLabel` module to add thumbnails to the image pages in the tree.

To get it working you need to have the basic setup:

1. Create new `image` field with input setting to 1 max image

2. Create new `image` template and add `title` and the `image` field created before

3. Create a 'image-category' template with only title and allow the `image` template and `image-category` as child pages under family settings.

4. Create a `image-root` template with only the title field for the root of the images tree. Allow only `image-category` as child page under family settings.

5. Create the root page with the `image-root` under the home page as "/images/"

6. Done.

The structure of the image repository looks like this

/images/

/cagetory1/

/imagesxy/

/category2/

/image2/

/image3/

Now you can use the ImagesManager to add categories and images. But you can also still use the page tree to add new stuff as usual.

The root path, template names and fields are configurable in the module settings.

How to install the module:

- Download the contents of this repository and put the folder renamed as "ImagesManager" into your site/modules/ folder

- Login in to ProcessWire and got to Modules page and click "Check for new modules". You should see a note that the two new module were found. Install the "ImagesManager" module.

- A new admin page "ImagesManager" should appear in the top menu.

- You may configure the option on the module screen to suit your needs.

Download at github

https://github.com/somatonic/ImagesManager

Thanks and enjoy.

  • Like 31
Link to comment
Share on other sites

This looks really awesome, Soma! Thanks so much for this (and also for helping me in regards to my image management concerns post). I will definitely be giving this a run... er, once I break through this wall of trouble I'm having with learning PW. In any case, this looks like quite the thing that could help me.

Questions:

How many images can this manager handle comfortably, would you say? And is this something that's server intensive?

Also, is this something that you'd recommend for the general handling of all images, or just the ones that would be reused?

Link to comment
Share on other sites

Soma, this is awesome!

One minor suggestion: Instead of copying the image code by hand perhaps it is possible to copy it on click with Javascript?

One major improvement: Somehow connect the image manager to a standard image field, so you can also insert existing images to it and / or mix it with single ones. Like I suggested here: http://processwire.com/talk/topic/1188-image-inputfield-like-in-tinymce/#entry10701 I know that we would need a way of symlinking to other images than the ones in the assets/files folder. But you are creative ;-)

Great work!

  • Like 3
Link to comment
Share on other sites

Bravo! This'll open the flood gates to folk who expect this functionality in whatever CMS they use.

"Somehow connect the image manager to a standard image field" <- An uber image field

I rarely stick images into a wysiwyg editor and I have dreams where the standard image field can either accept an upload or link to another image on another page.

  • Like 4
Link to comment
Share on other sites

Thanks guys!

Yes there I see some room for improvements to select the tag and also show some infos of the image size.

It's impossible to have image field select from those images. It would require a new image fueldtype. But that's not something that has to be connected to ImagesManager but just a field you can select an image page. Thats the great thing about this approach.

But you can do it with a page field easily. I'm doing it. If you use PageListSelect you'll even see the image thumb. And it would also be possible to select multiple or even just categories. This is even better than a dedicated fieldtype.

  • Like 1
Link to comment
Share on other sites

This looks really awesome, Soma! Thanks so much for this (and also for helping me in regards to my image management concerns post). I will definitely be giving this a run... er, once I break through this wall of trouble I'm having with learning PW. In any case, this looks like quite the thing that could help me.

Questions:

How many images can this manager handle comfortably, would you say? And is this something that's server intensive?

Also, is this something that you'd recommend for the general handling of all images, or just the ones that would be reused?

PW can handle x thousands of pages easily. Image Manager is using ajax based data table to list and search/filter those pages, so it scales infinitely. Also the abstraction of the images in texts uses page ID's searches, and this is pretty fast. So you could go as far as your server limit. It's not more intensive than PW itself. ImagesManager doesn't add a noticeable overhead.

You could use this for all images, but still also use the on page image field where it makes sense. However when sharing images and inserting those in Textareas, I think ImagesManager approach and its abstract feature is a big plus in handling those.

It's still alpha and it's possible some things may change on the way to a first RC. So it's not for use in production yet. 

  • Like 1
Link to comment
Share on other sites

I just pushed an update to 0.0.2 to github.

Some refactoring and some changes

- changed image tag syntax to use selector string syntax. This is easier to handle and I can use the PW selector class to read key=value easily.

Now supports:

{image=/path/, width=200, height=200, class=someclass, id=myimage, rel=album}
- improved image upload to use the image field settings for max size settings, also improved error handling there

- added some translations string

- changed data table some and added a input for the tag where when you click it will select the tag text automatic for easy copying.

- added modified date (sortable), also fixed some stuff with sortable of other cols

- added size col

- improved data table live search to search for also image description or image description field and title

Planned

- improve upload even more if/where possible

- add easy image delete function

- (Done) add textarea fields setting, to only insert "ImageManager" button to those specified

Any testing or help appreciated.

Thanks

  • Like 5
Link to comment
Share on other sites

  • 2 weeks later...

Hey Soma, very cool Manager!
(it's not the first time I say this, but it can't be said to often :) )
 
I want to ask if it is possible and if you find it useful, to include an optional userdefined callback-function that gets invoked in the public function executeUpload() method at line 517. After successful upload and the new ImagePage is saved calling it for example like this:
 

if( ! empty($this->options['userCallbackUpload']) && function_exists($this->options['userCallbackUpload']) ) {
  ${$this->options['userCallbackUpload']}( $imagepage );
}

 
With this, users may have a simple way to extend imagesPageTemplate with some more fields (e.g. for Exif-data). Yes, actually they allready have this option to extend the template or provide an own, but it would only allow to do a manually populating of fields. With a userCallbackFunction it could be done automatically.
 
Is this not of interest for the ImagesManager himself?
You may read Exif-description and IPTC-description fields and populate automatically the ImageDescriptionField. (IPTC has higher priority as EXIF).
 
So, if a user uses IPTC-description the field is allready filled, if not, and Exif-Description is available, this is used.
Downside: If there is unwanted text populated, the user has to change it manually. But with nothing populated automatically the user allways has to do it all manually.
 
Maybe it could be an boolean option: 'Yes, do autopopulate the image description' or 'NO'  ?
 
 
EDIT: approved code for reading this I can provide, - as you've said elsewhere: i'm the 'metadata-man' :P

  • Like 1
Link to comment
Share on other sites

Hey Mr MetaData!

Yeah sure why not. Since it does add value and it's only optional I think this is good idea to add.

I just went ahead and added support for MetaData in my last commit. You could now add a field "image_exif" and get the EXIF data stored when uploading images. I made the method setMetaData(), which adds the meta data on page/image creation, hookable so you can do a hook on it to store additional data. Not sure if this a good idea but maybe nice to have.

v 0.0.3

  • fixed issue with images getting added twice to the assets folder (hope this is now ok)
  • removed the performance intense pages search for image tags (In my testinstall with 120k pages this result in many second waiting to load the data table.
  • and just output a link on all images to a PW search that will run a search.
  • added EXIF data support.

Let me know if that EXIF data reading is ok, or if it need a more sophisticated method.

You can hook the Meta Data method like this from a autoload module:

$this->addHookAfter("ImagesManager::setMetaData", $this, "hookMetaData");

public function hookMetaData(HookEvent $event){
    $page = $event->arguments[0]; // page that the image will be added
    $file = $event->arguments[1]; // path of file in temp upload folder
    // do whatever you like
    $page->yourfield = "I'm the Meta Man!"; // will be saved to page
}
  • Like 3
Link to comment
Share on other sites

...

Let me know if that EXIF data reading is ok, or if it need a more sophisticated method.

...

Exif reading is perfect!  :)

We can retrieve the data with

$myExifArray = wireDecodeJSON( $myImagePage->image_exif ); 

EDIT:  Your solution is very elegant. The user who wants to get Exifdata may only add a TextareaField to his image-Template!

---

But there is something with the Textfield not allright: post-1041-0-90412700-1366564393_thumb.jp

I use Firefox on Windows

Edited by horst
Link to comment
Share on other sites

Hi, it's me again.
 
It would be really nice if we can have a field for IPTC as well:

'imagesIPTCField' => 'image_iptc',

and if you can provide their fieldnames within the hookable method:

$this->setMetaData($imagepage, $this->upload_path . $file, $this->options['imagesEXIFField'], $this->options['imagesIPTCField']);
public function ___setMetaData(Page $page, $file, $fieldnameExif, $fieldnameIPTC) {

If you want to populate IPTC data too:

		// write iptc data if field exists on page
		if($page->template->fieldgroup->hasField($this->options['imagesIPTCField'])) {
			$tmp = getimagesize($file, $info);
			if(isset($info['APP13'])) {
				$iptc = iptcparse($info['APP13']);
				if($iptc) {
					$page->set($this->options['imagesIPTCField'], json_encode($iptc));
				}
			}
		}

Link to comment
Share on other sites

The hook does already allow you to do any additional custom field saving... Just add field you wish and populate it in the hook.

Thx I'll have a look. Forgot FF isnt consistent across OS. I think I know what it is.

Link to comment
Share on other sites

The hook does already allow you to do any additional custom field saving... Just add field you wish and populate it in the hook.

Thx I'll have a look. Forgot FF isnt consistent across OS. I think I know what it is.

Allright ^-^ , - but getting the ExifFieldname would be of great help if the user changes the default name: function ___setMetaData(Page $page, $file, $fieldnameExif)

Many thanks!

Link to comment
Share on other sites

Hmm, wire("modules")->get("ImagesManger")->options[key] should be enough :) The module sets the options array in the init.

But you can also get it when you hook setMetaData() with 

$event->object->options['imagesEXIFField']; 
  • Like 1
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 LuisM
      Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider
      It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.
      The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.
      You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire
      Documentation
      The Symprowire Wiki https://github.com/Luis85/symprowire/wiki How to create a simple Blog with Symprowire https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial Last Update
      16.07.2021 // RC 1 v0.6.0 centralized ProcessWire access trough out the Application by wrapping to a Service https://github.com/Luis85/symprowire/releases/tag/v0.6.0-rc-1 Requirements
      PHP ^7.4 Fresh ProcessWire ^3.0.181 with a Blank Profile Composer 2 (v1 should work, not recommended) The usual Symfony Requirements Features
      Twig Dependency Injection Monolog for Symprowire Support for .env YAML Configuration Symfony Console and Console Commands Symfony Webprofiler Full ProcessWire access inside your Controller and Services Webpack Encore support Caveats
      Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

      So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env
       
    • By FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      https://github.com/SkyLundy/Fluency-Translation/archive/main.zip
      Github repository:
      https://github.com/SkyLundy/Fluency-Translation
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://github.com/SkyLundy/Fluency-Translation/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      New in version 1.1.0
      A new feature comes with version 1.1.0 which offers to record user names of loggedin visitors. Just activate "Record user names" and "Record loggedin user" in the module settings.
      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By clsource
      Inertia Adapter ProcessWire Module
      Hello! Long time no see.
      I created this module so you can use Inertia.js (https://inertiajs.com/) with ProcessWire.
      Description
      Inertia allows you to create fully client-side rendered, single-page apps, without much of the complexity that comes with modern SPAs. It does this by leveraging existing server-side frameworks.
      Inertia isn’t a framework, nor is it a replacement to your existing server-side or client-side frameworks. Rather, it’s designed to work with them. Think of Inertia as glue that connects the two. Inertia comes with three official client-side adapters (React, Vue, and Svelte).
      This is an adapter for ProcessWire. Inertia replaces PHP views altogether by returning JavaScript components from controller actions. Those components can be built with your frontend framework of choice.
      Links
      - https://github.com/joyofpw/inertia
      - https://github.com/joyofpw/inertia-svelte-mix-pw
      - https://inertiajs.com/
      Screenshots


       
    • By sms77io
      Hi all,
      we made a small module for sending SMS via Sms77.io. It supports sending to one and multiple users.
      You can download it from GitHub and follow the instructions on how to install it - it is quite easy. An API key is required for sending, get yours for free @ Sms77 and receive 0,50 €.
      Hope this helps somebody and we are open for improvement suggestions!
       
      Best regards
      André
×
×
  • Create New...