Jump to content
adrian

Custom Upload Names

Recommended Posts

Hi adrian,

Is there a way to use your module when images are uploaded via API (through a custom upload form)?

Share this post


Link to post
Share on other sites

Not at the moment, although that is a great idea. I'll look into it and see what I can come up with.

Share this post


Link to post
Share on other sites

Ok, sorry for the delay on this. I have added the ability to rename files uploaded via the API. It works on my testing using something simple like:

$page->images->add("/local_path_to_image/image.jpg"); 

$page->of(false);
$page->save();

I have attached a revised version of the module, rather than pushing to github for the moment. Please let me know if it works ok for you.

I am not sure how your upload form is working, but at the moment the module will rename the file in its original uploaded location before copying it to the final ID based folder under /assets/. I am not sure if this will work in all scenarios, but I had to use a "before" hook on "Pagefile::install" so that I could still change the filename using: 

$event->setArgument(0, $newFilename);

Using a before instead of after hook means that I am working with the file in its original location. It also means the module can't handle images from remote servers with full http:// paths. Does anyone have any ideas how I might be able to rename after it has been move to the assets/xxxx/ folder? None of the InputfieldFile hooks get called with API uploads, so they are out. I am thinking maybe I might need Pagefile::setFilename hookable, but I'd love to hear any ideas on how to do this.

On an unrelated note, I have also added the ability to drag/drop sort the rules in the module settings, making it easier to change the order as needed, which can be important if you have a lot of very specific rules that need to take precedence over more general ones later in the order.  

CustomUploadNames.zip

  • Like 2

Share this post


Link to post
Share on other sites

One more tweak this morning. There is now the option to 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.

I am not sure if this is what @peterfoeng was looking for in his post above, but hopefully people will find it useful regardless.

For the moment, this new version is only available as the attachment here.

CustomUploadNames.zip

  • Like 1

Share this post


Link to post
Share on other sites

Adrian, thanks for these updates. Are you going to be updating the GitHub repo for these changes as well?

Share this post


Link to post
Share on other sites

Hey Ryan,

I will update the GitHub repo for sure.

I was hoping to improve the hook for uploading via the API first though - I'd really like to delay the rename until after the file has been copied into the assets/xxxx folder so I am not messing with any file manipulation code that a front-end form might use. If it uploads the file to a temp directory and then makes the api call to install the file, eg: 

$page->images->add("/local_temp_path_to_image/image.jpg");

then the form won't know the new filename and so won't be able to delete the file from the temp location. Also, some of the front-end upload scripts posted to this forum suggest moving the file to the final assets/xxxx folder before using ->add, in which case the Pagefile::install won't even be triggered. I'd also like to be able to support images being added from an external URL.

Any thoughts on how best to achieve all these requirements? My post #28 above talks more about the issues with Pagefile::install and the need to run it as a before hook, but the problems that also causes. I am sure I must be missing an obvious option.

Share this post


Link to post
Share on other sites

Adrian, what about just using the Pagefile::rename function from a hook after Pagefile::install ? I may not be understanding the issue in full. But couldn't you just do something like this:

public function hookAfterPagefileInstall($event) {
  $pagefile = $event->object;
  $pagefile->rename('filename.' . $pagefile->ext); 
}
  • Like 1

Share this post


Link to post
Share on other sites

Thanks Ryan - very easy and effective. I didn't think about the rename function - was wondering how to rename the file as well as the pagefile in one easy process.

I have pushed a new version to GitHub which uses this for API uploads and as a result can now support renaming files that are added from remote URLs.

I think this should now work in all API / form scenarios, but if anyone comes across any issues, please let me know.

  • Like 1

Share this post


Link to post
Share on other sites

Hi everyone,

Another overhaul today. A few bug fixes and a bunch of new features. I have updated the first post here to detail them better, but key things are the ability to make use of the following variables in the filename format: $page, $template, $field, and $file.

To accommodate some of possibilities this opens up, eg: $file->description, there is new logic to handle renaming after page save if the filename format can't be properly evaluated at upload because the field isn't available yet, or is still blank. If possible, renaming will still occur during upload - "on save" is just a fallback if needed.

Another key addition is the ability to give each rule the option to rename the file again each time the page is saved. There are obvious issues with this if images or files are being linked directly by their URL, so care is needed with this option checked. It does allow for some incredible flexibility though. You could even have a field in your template called "Filename" allowing the user to rename the file whenever they want. In most scenarios of course this would not be at all desirable, but it suited my needs, so thought it might come in handy for someone else as well :) If nothing else, it might be useful during development, but could be disabled once the site is live.

Let me know if you find any bugs with this new functionality.

  • Like 3

Share this post


Link to post
Share on other sites

How should this be modified to have Datetime field in its output format instead of Unix timestamp in "Filename Format"?

Share this post


Link to post
Share on other sites

How should this be modified to have Datetime field in its output format instead of Unix timestamp in "Filename Format"?

I have just committed an update that makes this work as expected.

Because in the admin panel outputformatting is off by default, it needed to be manually turned on. I don't think there should be a problems with doing this in Custom Upload Names and some quick testing shows that it seems to be working fine, but please let me know if you discover any weird side-effects.

  • Like 1

Share this post


Link to post
Share on other sites

I also just added another formatting option that allows you to include the current date time in the filename, eg:

{$page->name}-[Y-m-d_H-i-s]-suffix

Anything inside square brackets will be treated as a php date format string and will be applied to the date/time when the file is uploaded and renamed.

You could instead use $page->created or $page->modified, but since these don't have a configurable output format, this seemed like a more flexible approach.

I think this should be a useful addition in several scenarios.

Share this post


Link to post
Share on other sites

Thank you for the quick response and feature implementation! It works for me as expected.

Yesterday I spent a few hours thinking how I could do renaming like this and then I discovered your module already existed :rolleyes:

  • Like 1

Share this post


Link to post
Share on other sites

Hi,

I think I found another little thingie.

Yesterday I've decided to use an image-field in a repeater, custom name was enabled. I think you already know where I'm going :-)

The image didn't get saved, disabling did help.

Greetings.

Share this post


Link to post
Share on other sites

Hi,

I think I found another little thingie.

Yesterday I've decided to use an image-field in a repeater, custom name was enabled. I think you already know where I'm going :-)

The image didn't get saved, disabling did help.

Greetings.

Yeah, unfortunately I do know about this already - was just hoping it wouldn't come up :)

I made an initial attempt to fix it, but couldn't figure out a solution at the time. Then the new PageTable field was developed which Ryan recommends over repeaters in almost all scenarios so I didn't worry about it too much.

I'll take another look and see what I can do, but you really should try PageTables - so much nicer (and less problematic) than repeaters :)

Share this post


Link to post
Share on other sites

Oops... sorry....

I've heard/seen a lot of buzzing about the PageTables [and extended] but I haven't found the time to try it out...

Soon... so don't worry about it... it's fine...

Share this post


Link to post
Share on other sites

Supposed I upload multiple files at a time and want them to be rename to the following format format:

mysite-[Y-m-d]-{$file->description}

The problem is that all the files get renamed immediately (before hitting the save button) like this:

tmp-filename.pdf
tmp-filename-1.pdf
tmp-filename-2.pdf
...

Now, how can I tell which tmp-filename belongs to which original file? Sure, I could still open the files by clicking on their filename. But what if the new file format would only be applied after hitting the save button?

Share this post


Link to post
Share on other sites

Hi charger - sorry, I am not sure what the problem actually is. Because you have chosen to use $file->description the module has to use the tmp-filename option until the page is saved, when the description field is available. If you used $page-name or something else that is already available when the file is uploaded, it will rename fully as soon as it is uploaded. Maybe you have already figured that out though? 

Why do you need to know which file is which before you save the page? Once the page is saved the names will match the entered descriptions. 

Perhaps if you could explain your usage scenario I might be able to come up with a solution for you.

I am on vacation for the next two weeks though, starting in a few hours, so I might not be able to do anything until then, unless a clear idea emerges and it is easy to implement.

I guess I could go with renaming on page save, but that always seemed less elegant - shouldn't be too hard to make it an option though.

Share this post


Link to post
Share on other sites

The problem is that if I upload 10 files at a time and they all get renamed to tmp-filename.pdf before saving, then I have no chance to see the original filename and thus write the according description to it.

An example: I upload a file that is originally named 30_10_2014_EventHappyMonday.pdf. In order to know what to fill in in the description field (in this case it would be "Event Happy Monday"), it helps a lot if I still see the original filename and not tmp-filename.pdf.

Enjoy your holidays!

Share this post


Link to post
Share on other sites

Sorry now I understand - it's the writing of the description that is the problem - makes total sense :)

I often use this module with images (so not an issue), and when I do it with PDFs and other files I haven't ever used $file->description so I haven't had this issue yet.

The tricky thing about trying to fix this is that filename formats that use fields that aren't available at upload (like description) need to be renamed on save, but if you don't want the name to also change on each future file save (which you wouldn't given that you are including the date in the filename), the module needs to know it is the first time the file has been saved, which is why I use the tmp-filename intermediate renaming. Only files named tmp-filename get renamed on save. All others are ignored unless the "Rename on Save" option is checked.

It's almost 2am here and this is not a simple fix, so I am sorry, but I think it will have to wait a couple of weeks, but I'll definitely put it on my list and I'll let you know when I have a solution.

Share this post


Link to post
Share on other sites

Hey charger - woke up with an obvious solution. I just committed an update that should take care of your needs.

Now the temporary filename is: original-filename.upload.tmp.pdf

Hope that works well for you.

Thanks for letting me know about this.

  • Like 3

Share this post


Link to post
Share on other sites

Just tested it and works like a charm. Thanks a lot for the quick support!

  • Like 1

Share this post


Link to post
Share on other sites

Not sure about actually dreaming, but definitely in that blurry time while falling asleep and then lying there after just waking up - brain seems more clear and tries to actually figure out the problem, rather than the trial and error approach that can sometimes happen when you're at the computer trying to get something to work.

  • Like 2

Share this post


Link to post
Share on other sites

Here it's works the same. Recognise it as a whole.

But I do remember I'm programming in my dreams...

Edited by Martijn Geerts
one of the most inspiring movies i've seen: Pi

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 bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
    • By adrian
      Hi everyone,
      Here's a new module that I have been meaning to build for a long time.
      http://modules.processwire.com/modules/process-admin-actions/
      https://github.com/adrianbj/ProcessAdminActions
       
      What does it do?
      Do you have a bunch of admin snippets laying around, or do you recreate from them from scratch every time you need them, or do you try to find where you saw them in the forums, or on the ProcessWire Recipes site?
      Admin Actions lets you quickly create actions in the admin that you can use over and over and even make available to your site editors (permissions for each action are assigned to roles separately so you have full control over who has access to which actions).
       
      Included Actions
      It comes bundled with several actions and I will be adding more over time (and hopefully I'll get some PRs from you guys too). You can browse and sort and if you have @tpr's Admin on Steroid's datatables filter feature, you can even filter based on the content of all columns. 

      The headliner action included with the module is: PageTable To RepeaterMatrix which fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field. This is a huge timesaver if you have an existing site that makes heavy use of PageTable fields and you would like to give the clients the improved interface of RepeaterMatrix.
      Copy Content To Other Field
      This action copies the content from one field to another field on all pages that use the selected template.
      Copy Field Content To Other Page
      Copies the content from a field on one page to the same field on another page.
      Copy Repeater Items To Other Page
      Add the items from a Repeater field on one page to the same field on another page.
      Copy Table Field Rows To Other Page
      Add the rows from a Table field on one page to the same field on another page.
      Create Users Batcher
      Allows you to batch create users. This module requires the Email New User module and it should be configured to generate a password automatically.
      Delete Unused Fields
      Deletes fields that are not used by any templates.
      Delete Unused Templates
      Deletes templates that are not used by any pages.
      Email Batcher
      Lets you email multiple addresses at once.
      Field Set Or Search And Replace
      Set field values, or search and replace text in field values from a filtered selection of pages and fields.
      FTP Files to Page
      Add files/images from a folder to a selected page.
      Page Active Languages Batcher
      Lets you enable or disable active status of multiple languages on multiple pages at once.
      Page Manipulator
      Uses an InputfieldSelector to query pages and then allows batch actions on the matched pages.
      Page Table To Repeater Matrix
      Fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field.
      Template Fields Batcher
      Lets you add or remove multiple fields from multiple templates at once.
      Template Roles Batcher
      Lets you add or remove access permissions, for multiple roles and multiple templates at once.
      User Roles Permissions Batcher
      Lets you add or remove permissions for multiple roles, or roles for multiple users at once.
       
      Creating a New Action
      If you create a new action that you think others would find useful, please add it to the actions subfolder of this module and submit a PR. If you think it is only useful for you, place it in /site/templates/AdminActions/ so that it doesn't get lost on module updates.
      A new action file can be as simple as this:
      class UnpublishAboutPage extends ProcessAdminActions { protected function executeAction() { $p = $this->pages->get('/about/'); $p->addStatus(Page::statusUnpublished); $p->save(); return true; } } Each action:
      class must extend "ProcessAdminActions" and the filename must match the class name and end in ".action.php" like: UnpublishAboutPage.action.php the action method must be: executeAction() As you can see there are only a few lines needed to wrap the actual API call, so it's really worth the small extra effort to make an action.
      Obviously that example action is not very useful. Here is another more useful one that is included with the module. It includes $description, $notes, and $author variables which are used in the module table selector interface. It also makes use of the defineOptions() method which builds the input fields used to gather the required options before running the action.
      class DeleteUnusedFields extends ProcessAdminActions { protected $description = 'Deletes fields that are not used by any templates.'; protected $notes = 'Shows a list of unused fields with checkboxes to select those to delete.'; protected $author = 'Adrian Jones'; protected $authorLinks = array( 'pwforum' => '985-adrian', 'pwdirectory' => 'adrian-jones', 'github' => 'adrianbj', ); protected function defineOptions() { $fieldOptions = array(); foreach($this->fields as $field) { if ($field->flags & Field::flagSystem || $field->flags & Field::flagPermanent) continue; if(count($field->getFieldgroups()) === 0) $fieldOptions[$field->id] = $field->label ? $field->label . ' (' . $field->name . ')' : $field->name; } return array( array( 'name' => 'fields', 'label' => 'Fields', 'description' => 'Select the fields you want to delete', 'notes' => 'Note that all fields listed are not used by any templates and should therefore be safe to delete', 'type' => 'checkboxes', 'options' => $fieldOptions, 'required' => true ) ); } protected function executeAction($options) { $count = 0; foreach($options['fields'] as $field) { $f = $this->fields->get($field); $this->fields->delete($f); $count++; } $this->successMessage = $count . ' field' . _n('', 's', $count) . ' ' . _n('was', 'were', $count) . ' successfully deleted'; return true; } }  
      This defineOptions() method builds input fields that look like this:

      Finally we use $options array in the executeAction() method to get the values entered into those options fields to run the API script to remove the checked fields.
      There is one additional method that I didn't outline called: checkRequirements() - you can see it in action in the PageTableToRepeaterMatrix action. You can use this to prevent the action from running if certain requirements are not met.
      At the end of the executeAction() method you can populate $this->successMessage, or $this->failureMessage which will be returned after the action has finished.
       
      Populating options via URL parameters
      You can also populate the option parameters via URL parameters. You should split multiple values with a “|” character.
      You can either just pre-populate options:
      http://mysite.dev/processwire/setup/admin-actions/options?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add
      or you can execute immediately:
      http://mysite.dev/processwire/setup/admin-actions/execute?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add

      Note the “options” vs “execute” as the last path before the parameters.
       
      Automatic Backup / Restore
      Before any action is executed, a full database backup is automatically made. You have a few options to run a restore if needed:
      Follow the Restore link that is presented after an action completes Use the "Restore" submenu: Setup > Admin Actions > Restore Move the restoredb.php file from the /site/assets/cache/AdminActions/ folder to the root of your site and load in the browser Manually restore using the AdminActionsBackup.sql file in the /site/assets/cache/AdminActions/ folder I think all these features make it very easy to create custom admin data manipulation methods that can be shared with others and executed using a simple interface without needing to build a full Process Module custom interface from scratch. I also hope it will reduce the barriers for new ProcessWire users to create custom admin functionality.
      Please let me know what you think, especially if you have ideas for improving the interface, or the way actions are defined.
       
       
    • By joshua
      ---
      Module Directory: https://modules.processwire.com/modules/privacy-wire/
      Github: https://github.com/blaueQuelle/privacywire/
      Packagist:https://packagist.org/packages/blauequelle/privacywire
      Module Class Name: PrivacyWire
      Changelog: https://github.com/blaueQuelle/privacywire/blob/master/Changelog.md
      ---
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Functional
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The data-attributes (data-type and data-category) are required to get recognized by PrivacyWire. the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button>  
      I would love to hear your feedback 🙂
      CHANGELOG
      You can find the always up-to-date changelog file here.
    • By joshua
      As we often use Matomo (former known as Piwik) instead of Google Analytics we wanted to embed Matomo not only in the template code but also via the ProcessWire backend.
      That's why I developed a tiny module for the implementation.
      The module provides the possibility to connect to an existing Matomo installation with the classical site tracking and also via the Matomo Tag Manager.
      If you have also PrivacyWire installed, you can tell MatomoWire to only load the script, if the user has accepted cookies via PrivacyWire.
      To offer an Opt-Out solution you can choose between the simple Opt-Out iFrame, delivered by your Matomo installation, or a button to choose cookies via PrivacyWire.
      You'll find the module both in the module directory and via github:
      ProcessWire Module Directory MatomoWire @ GitHub MatomoWire @ Packagist ->installable via composer require blauequelle/matomowire I'm looking forward to hear your feedback!


×
×
  • Create New...