Jump to content
adrian

Custom Upload Names

Recommended Posts

This module allows you to automatically rename file (including image) uploads according to a configurable format

This module lets you define as many rules as you need to determine how uploaded files will be named and you can have different rules for different pages, templates, fields, and file extensions, or one rule for all uploads. Renaming works for files uploaded via the admin interface and also via the API, including images added from remote URLs.
 

Github: https://github.com/adrianbj/CustomUploadNames

Modules Directory: http://modules.processwire.com/modules/process-custom-upload-names/

Renaming Rules

  • The module config allows you to set an unlimited number of Rename Rules.
  • You can define rules to specific fields, templates, pages, and file extensions.
  • If a rule option is left blank, the rule with be applied to all fields/templates/pages/extensions.
  • Leave Filename Format blank to prevent renaming for a specific field/template/page combo, overriding a more general rule.
  • Rules are processed in order, so put more specific rules before more general ones. You can drag to change the order of rules as needed.
  • The following variables can be used in the filename format: $page, $template, $field, and $file. For some of these (eg. $field->description), if they haven't been filled out and saved prior to uploading the image, renaming won't occur on upload, but will happen on page save (could be an issue if image has already been inserted into RTE/HTML field before page save). Some examples:
    • $page->title
    • mysite-{$template->name}-images
    • $field->label
    • $file->description
    • {$page->name}-{$file->filesize}-kb
    • prefix-[Y-m-d_H-i-s]-suffix (anything inside square brackets is is considered to be a PHP date format for the current date/time)
    • randstring[n] (where n is the number of characters you want in the string)
    • ### (custom number mask, eg. 001 if more than one image with same name on a page. This is an enhanced version of the automatic addition of numbers if required)
  • If 'Rename on Save' is checked files will be renamed again each time a page is saved (admin or front-end via API). WARNING: this setting will break any direct links to the old filename, which is particularly relevant for images inserted into RTE/HTML fields.
  • The Filename Format can be defined using plain text and PW $page variable, for example: mysite-{$page->path}
  • You can preserve the uploaded filename for certain rules. This will allow you to set a general renaming rule for your entire site, but then add a rule for a specific page/template/field that does not rename the uploaded file. Just simply build the rule, but leave the Filename Format field empty.
  • You can specify an optional character limit (to nearest whole word) for the length of the filename - useful if you are using $page->path, $path->name etc and have very long page names - eg. news articles, publication titles etc.

NOTE - if you are using ProcessWire's webp features, be sure to use the useSrcExt because if you have jpg and png files on the same page and your rename rules result in the same name, you need to maintain the src extension so they are kept as separate files.

$config->webpOptions = array(
    'useSrcExt' => false, // Use source file extension in webp filename? (file.jpg.webp rather than file.webp)
);

Acknowledgments

The module config settings make use of code from Pete's EmailToPage module and the renaming function is based on this code from Ryan: http://processwire.com/talk/topic/3299-ability-to-define-convention-for-image-and-file-upload-names/?p=32623 (also see this post for his thoughts on file renaming and why it is the lazy way out - worth a read before deciding to use this module). 

 

 

NOTE:

This should not be needed on most sites, but I work with lots of sites that host PDFs and photos/vectors that are available for download and I have always renamed the files on upload because clients will often upload files with horrible meaningless filenames like:

Final ReportV6 web version for John Feb 23.PDF

post-985-0-03753500-1392939647_thumb.png

  • Like 12

Share this post


Link to post
Share on other sites

Just pushed a new version to Github that supports setting a filename length limit (to nearest whole word) for the length of the filename - useful if you are using 

$page->path, $path->name etc 

and have very long page names - eg. news articles, publication titles etc. The final filename will be truncated to this length if set.

I have also added support for jquery 'on' as well as 'live' depending on what is available.

I have one thing I'd like to sort out before releasing this if anyone has any ideas. I can't seem to get dynamically added (click "Add another rule") ASM fields to properly initialize. The:

<select class="asmSelect" name="asmSelect2" id="asmSelect2">

is not being setup, so the fields just looks like a standard html multi-select field until the config settings page gets saved, then it works fine. I am wondering if there is an easy way to fix this. I haven't looked through things thoroughly yet, but it seems weird that the InputfieldPageListSelectMultiple field is working properly.

Any ideas?

I have the ASM fields now mostly working (works almost every time a new rule is added, but not 100% for some reason). I resorted to a setTimeout to wait until the select form elements are created. I feel like there should be a better way to do this, but it is something I always struggle with a little in jquery. I have used this function in the past: https://gist.github.com/aziz/3792797 but I still think there should be a better way. Anyone?

  • Like 2

Share this post


Link to post
Share on other sites

Nice job Adrian! Please add to the modules directory too, when you are ready. 

Share this post


Link to post
Share on other sites

Great job Adrian!

Very useful, and works well with CropImage module also.

Two notice when there are no rules:

Notice: Undefined index: ruleData in .../site/modules/CustomUploadNames/ProcessCustomUploadNames.module on line 249
Notice: Undefined index: filenameLength in .../site/modules/CustomUploadNames/ProcessCustomUploadNames.module on line 264

And.. something to fix with new admin themes.

Share this post


Link to post
Share on other sites

Hi maba, 

Thanks for the positive feedback and picking up on those errors. Only catch is that line 249 doesn't refer to ruleData, so I am wondering if you are running the latest version (0.0.8). Can you please check again with the latest version and let me know what, if any messages you get. I don't get any notices show up at all.

Did you mean to attach a screenshot regarding the fix for the new admin theme?

Thanks,

Adrian

Share this post


Link to post
Share on other sites

Hi,

in attach some screenshot about theme issues. Some problem with margin and padding.

You are right, line 249 is not about ruleData, but with last dev and the last module version I catch this warning.

I'll try with a clean PW installation.
 

New problem: I cannot add rules (see image). Problem with ASM select.

Ooops.. probably you know this issue.

post-846-0-23322000-1384779616_thumb.png

post-846-0-02277500-1384779621_thumb.png

Share this post


Link to post
Share on other sites

Thanks for the extra details. I know about the layout on the new theme - to be honest I haven't looked at this thoroughly yet as I wanted to make sure Ryan had finalized exactly what classes will be used in the layout of these things. I will definitely keep it on my list of things to tweak though.

As for the ASM issue. It currently seems random - sometimes it works as expected and other times it doesn't work properly. Regardless, you can use the field like a normal multiselect field and it will work fine and be converted to an ASM on save. I will look into this when I have some more time and see if I can solve it more reliably. The key thing is that it shouldn't affect the ability of the module to work until I get it sorted.

Share this post


Link to post
Share on other sites

About new theme.. it is only a warning, you are right.  :rolleyes:

In my case I cannot save the second rule.

How can I test it?

Thanks

Share this post


Link to post
Share on other sites

Based on your screenshot, I see that you haven't entered anything in the "Filename Format" field. Since the rule can't do anything without this field, this is a required field - the only one of fields which is, and the rule won't save unless it is filled out. 

Can you please try again with that field filled out.

Thanks

Share this post


Link to post
Share on other sites

I am really sorry you are having trouble with this. I can save multiple rules here no problem. I just pushed a small update to make the format field "required", but obviously that isn't your issue. I am curious if you are having the same problem saving when using other/older themes, and also what browser/OS you are on. Do you get any logged errors, or does the rule just not appear when the page reloads?

Share this post


Link to post
Share on other sites

No problem Adrian, it is under development.

Tested also with standard theme, Safari and Chrome on OSX.

No errors, the rule not appear, like screenshot.

post-846-0-18005100-1384846545_thumb.png

post-846-0-29887100-1384846556_thumb.png

Share this post


Link to post
Share on other sites

Mmmm.. can the module have a problem with latest PW (2.3.7)?

  • Like 1

Share this post


Link to post
Share on other sites

Catched! #Inputfield_submit shoud be #Inputfield_sumbit_save_module in ProcessCustomUploadNames.js:

$('#Inputfield_submit_save_module').click(function(e) {
  • Like 1

Share this post


Link to post
Share on other sites

Thank you very much for the troubleshooting. I was testing with 2.3.5 and it was working fine. I see that with 2.3.7 the button now has that new id, whereas with 2.3.5, it was the containing <li> that had that id, but the button itself had #Inputfield_submit.

So I just pushed another update that lists both ids, comma separated so it should support old and new versions of PW. 

Thanks again for your help with this and please let me know if you find any other problems!

Share this post


Link to post
Share on other sites

One more small update pushed to github to hopefully fix the ASM initialization issue.

maba - would you please mind checking to see if the new rules now consistently work as ASM fields please?

Thanks

Share this post


Link to post
Share on other sites

Adrian, thanks for the updates.

Unfortunately the ASM problem persists. I'll made other test with clean PW installation.

Share this post


Link to post
Share on other sites

Can you do me a favor and try changing Line 15 of the .js file from 200 to 500 to see if that helps. The change from 100 to 200 seems to have made it work all the time at my end, but maybe there are other issues. 

EDIT: are you getting any related console errors?

Share this post


Link to post
Share on other sites

Ok, I have swapped out the timeout approach for a callback, so hopefully that will solve it in a much better way. 

I have pushed this fix to github and the module is also now approved in the modules directory, so you should be able to update much more easily now.

Please let me know if that works now.

  • Like 1

Share this post


Link to post
Share on other sites

Hi Adrian,

I am wondering if the module is missing "Add another rule button". PW version 2.3.0.3 and I am using version 0.1.3 (the delete button is present though)

iz0a1gz.png

Share this post


Link to post
Share on other sites

Looks like, jQuery cannot find the reference to this $('#RenameRules .InputfieldContent:first'), that's why the button is never added to the DOM :) Hope this can't be fixed :) Cheers

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for the bug report. I was really only testing on the latest dev version of PW. I have just pushed a new version to github that seems to work fine with 2.3.

Please test and let me know how you go with it. 

I really should do some more tweaks on the css for this module, but am waiting till PW 2.4 and the new default admin theme are released as stable.

  • Like 1

Share this post


Link to post
Share on other sites

Hi Adrian,


Thanks for making this changes - confirmed this is working for 2.3.0.3

Anyway, I am thinking and wishing if there is a support for preserving the original filename on top of what is already offered? :)

Share this post


Link to post
Share on other sites

Hi Peter,

Are you suggesting you'd like two copies of the file then - one with the original name and one with the new custom name? My initial thought on this is that it will be problematic when you go to delete an image, as one version would be left behind. Of course it would be possible to extend the file fieldtype to store the original filename as well and either do a redirect, or keep record of the second version of the file. If two physical files were stored, it could be linked when deleting so both are deleted. I think at the moment these options are beyond the scope of this module. I think it is doable, but I think there might be some further thinking required to make sure there aren't any other complicating issues.

Can you please further explain your usage scenario for wanting to keep the original filename? Maybe that will better help me to figure out the best the approach.

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 teppo
      Needed a really simple solution to embed audio files within page content and couldn't find a module for that, so here we go. Textformatter Audio Embed works a bit like Textformatter Video Embed, converting this:
      <p>https://www.domain.tld/path/to/file.mp3</p> Into this:
      <audio controls class="TextformatterAudioEmbed"> <source src="https://www.domain.tld/path/to/file.mp3" type="audio/mpeg"> </audio> The audio element has pretty good browser support, so quite often this should be enough to get things rolling 🙂
      GitHub repository: https://github.com/teppokoivula/TextformatterAudioEmbed Modules directory: https://modules.processwire.com/modules/textformatter-audio-embed/
    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By Chris Bennett
      Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
      I am sure I am doing something dumb, or missing something I should know, but don't. Story of my life 😉

      Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
      Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

      InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
      Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
      Undoubtedly not helped by me not knowing enough.

      Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.
      If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
       
      public function ___install() { parent::___install(); $page = $this->pages->get('name='.self::PAGE_NAME); if (!$page->id) { // Create fieldgroup, template, fields and page // Create new fieldgroup $fmFieldgroup = new Fieldgroup(); $fmFieldgroup->name = MODULE_NAME.'-fieldgroup'; $fmFieldgroup->add($this->fields->get('title')); // needed title field $fmFieldgroup->save(); // Create new template using the fieldgroup $fmTemplate = new Template(); $fmTemplate->name = MODULE_NAME; $fmTemplate->fieldgroup = $fmFieldgroup; $fmTemplate->noSettings = 1; $fmTemplate->noChildren = 1; $fmTemplate->allowNewPages = 0; $fmTemplate->tabContent = MODULE_NAME; $fmTemplate->noChangeTemplate = 1; $fmTemplate->setIcon(ICON); $fmTemplate->save(); // Favicon source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFavicon'; $fmField->label = 'Favicon'; $fmField->focusMode = 'off'; $fmField->gridMode = 'grid'; $fmField->extensions = 'svg png'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Favicon Silhouette source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFaviconSilhouette'; $fmField->label = 'SVG Silhouette'; $fmField->notes = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires. In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.'; $fmField->focusMode = 'off'; $fmField->extensions = 'svg'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Create: Open Settings Tab $tabOpener = new Field(); $tabOpener->type = new FieldtypeFieldsetTabOpen(); $tabOpener->name = 'fmTab1'; $tabOpener->label = "Favicon Settings"; $tabOpener->collapsed = Inputfield::collapsedNever; $tabOpener->addTag(MODULE_NAME); $tabOpener->save(); // Create: Close Settings Tab $tabCloser = new Field(); $tabCloser->type = new FieldtypeFieldsetClose; $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier; $tabCloser->label = "Close open tab"; $tabCloser->addTag(MODULE_NAME); $tabCloser->save(); // Create: Opens wrapper for Favicon Folder Name $filesOpener = new Field(); $filesOpener->type = new FieldtypeFieldsetOpen(); $filesOpener->name = 'fmOpenFolderName'; $filesOpener->label = 'Wrap Folder Name'; $filesOpener->class = 'inline'; $filesOpener->collapsed = Inputfield::collapsedNever; $filesOpener->addTag(MODULE_NAME); $filesOpener->save(); // Create: Close wrapper for Favicon Folder Name $filesCloser = new Field(); $filesCloser->type = new FieldtypeFieldsetClose(); $filesCloser->name = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier; $filesCloser->label = "Close open fieldset"; $filesCloser->addTag(MODULE_NAME); $filesCloser->save(); // Create Favicon Folder Name $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeText"); $fmField->name = 'folderName'; $fmField->label = 'Favicon Folder:'; $fmField->description = $this->config->urls->files; $fmField->placeholder = 'Destination Folder for your generated favicons, webmanifest and browserconfig'; $fmField->columnWidth = 100; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon('folder'); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($tabOpener); $fmFieldgroup->add($filesOpener); $fmFieldgroup->add($fmField); $fmFieldgroup->add($filesCloser); $fmFieldgroup->add($tabCloser); $fmFieldgroup->save(); /////////////////////////////////////////////////////////////// // Experimental Markup Tests $wrapperFaviconMagic = new InputfieldWrapper(); $wrapperFaviconMagic->attr('id','faviconMagicWrapper'); $wrapperFaviconMagic->attr('title',$this->_('Favicon Magic')); // field show info what $field = $this->modules->get('InputfieldMarkup'); $field->name = 'use'; $field->label = __('How do I use it?'); $field->collapsed = Inputfield::collapsedNever; $field->icon('info'); $field->attr('value', 'Does this even begin to vaguely work?'); $field->columnWidth = 50; $wrapperFaviconMagic->add($field); $fmTemplate->fields->add($wrapperFaviconMagic); $fmTemplate->fields->save(); ///////////////////////////////////////////////////////////// // Create page $page = $this->wire( new Page() ); $page->template = MODULE_NAME; $page->parent = $this->wire('pages')->get('/'); $page->addStatus(Page::statusHidden); $page->title = 'Favicons'; $page->name = self::PAGE_NAME; $page->process = $this; $page->save(); } }  
    • By Sebi
      Since it's featured in ProcessWire Weekly #310, now is the time to make it official:
      Here is Twack!
      I really like the following introduction from ProcessWire Weekly, so I hope it is ok if I use it here, too. Look at the project's README for more details!
      Twack is a new — or rather newish — third party module for ProcessWire that provides support for reusable components in an Angular-inspired way. Twack is implemented as an installable module, and a collection of helper and base classes. Key concepts introduced by this module are:
      Components, which have separate views and controllers. Views are simple PHP files that handle the output for the component, whereas controllers extend the TwackComponent base class and provide additional data handling capabilities. Services, which are singletons that provide a shared service where components can request data. The README for Twack uses a NewsService, which returns data related to news items, as an example of a service. Twack components are designed for reusability and encapsulating a set of features for easy maintainability, can handle hierarchical or recursive use (child components), and are simple to integrate with an existing site — even when said site wasn't originally developed with Twack.
      A very basic Twack component view could look something like this:
      <?php namespace ProcessWire; ?> <h1>Hello World!</h1> And here's how you could render it via the API:
      <?php namespace Processwire; $twack = $modules->get('Twack'); $hello = $twack->getNewComponent('HelloWorld'); ?> <html> <head> <title>Hello World</title> </head> <body> <?= $hello->render() ?> </body> </html> Now, just to add a bit more context, here's a simple component controller:
      <?php namespace ProcessWire; class HelloWorld extends TwackComponent { public function __construct($args) { parent::__construct($args); $this->title = 'Hello World!'; if(isset($args['title'])) { $this->title = $args['title']; } } } As you can see, there's not a whole lot new stuff to learn here if you'd like to give Twack a try in one of your projects. The Twack README provides a really informative and easy to follow introduction to all the key concepts (as well as some additional examples) so be sure to check that out before getting started. 
      Twack is in development for several years and I use it for every new project I build. Also integrated is an easy to handle workflow to make outputs as JSON, so it can be used to build responses for a REST-api as well. I will work that out in one section in the readme as well. 
      If you want to see the module in an actual project, I have published the code of www.musical-fabrik.de in a repository. It runs completely with Twack and has an app-endpoint with ajax-output as well.
      I really look forward to hear, what you think of Twack🥳!
      Features Installation Usage Quickstart: Creating a component Naming conventions & component variants Component Parameters directory page parameters viewname Asset handling Services Named components Global components Ajax-Output Configuration Versioning License Changelog
    • By Robin S
      Page Reference Default Value
      Most ProcessWire core inputfield types that can be used with a Page Reference field support a "Default value" setting. This module extends support for default values to the following core inputfield types:
      Page List Select Page List Select Multiple Page Autocomplete (single and multiple) Seeing as these inputfield types only support the selection of pages a Page List Select / Page List Select Multiple is used for defining the default value instead of the Text / Textarea field used by the core for other inputfield types. This makes defining a default value a bit more user-friendly.
      Note that as per the core "Default value" setting, the Page Reference field must be set to "required" in order for the default value to be used.
      Screenshot

       
      https://github.com/Toutouwai/PageReferenceDefaultValue
      https://modules.processwire.com/modules/page-reference-default-value/
×
×
  • Create New...