Jump to content
adrian

Custom Upload Names

Recommended Posts

3 minutes ago, adrian said:

Ok, I think I have narrowed it down - if you don't have "overwrite" checked and you use $file->mtime it doesn't know how to name the file at the correct point it needs to. Let me see if I can fix.

Yep, I'm getting the same results with you.

  • Like 1

Share this post


Link to post
Share on other sites

@PWaddict - I have managed to solve the problem you are seeing, but there is another issue when using $file->mtime in the rename rule for images in repeaters that I am having trouble fixing. The problem is that when you save an image, the mtime changes and there is an order problem with the mtime changing before or after the renaming of the pagefile which is causing problems. I noticed though that it all works fine if you use $file->modified instead. Would that work ok for your needs instead of mtime?

  • Like 1

Share this post


Link to post
Share on other sites
9 hours ago, adrian said:

I noticed though that it all works fine if you use $file->modified instead. Would that work ok for your needs instead of mtime?

Thanks a lot. I switched from mtime to modified and the problem is gone :) Maybe you should add a note on the Rename rules to avoid using mtime.

Share this post


Link to post
Share on other sites
1 minute ago, PWaddict said:

Thanks a lot. I switched from mtime to modified and the problem is gone 🙂 Maybe you should add a note on the Rename rules to avoid using mtime.

Maybe I could programmatically replace mtime with modified. Can you think of any reason why mtime would actually be needed vs modified?

Share this post


Link to post
Share on other sites
3 minutes ago, adrian said:

Maybe I could programmatically replace mtime with modified. Can you think of any reason why mtime would actually be needed vs modified?

modified: Unix timestamp of when Pagefile (file, description or tags) was last modified.
mtime: Unix timestamp of when file (only) was last modified.

Taken from Pagefile API Reference.

Share this post


Link to post
Share on other sites

I'm trying to use this module, but currently no renaming is happening, either on upload or after save.

My rule is : {$page->compGrade->title}_{$page->compSubject->title}_{$page->compMedium->title}_{$page->title}

$page->compSubject and $page->compMedium are Options fieldtype.

I get for example: imgp0887_upload_tmp.jpg which is definitely not right.

I'm on PW 3.0.144

There's not by any chance an issue with the module not handling mixed case field names? Processwire itself does allow mixed case field names, however I've struck several modules including from Ryan himself, that convert everything to lowercase, to match database table names.

That's the only thing I can think of that might be causing renaming not to work.

Here's screenshot of configuration below:

 

image.thumb.png.34047fdfaca68c058b87b018363a00dc.png

Share this post


Link to post
Share on other sites

Hey @Kiwi Chris - the "_upload_tmp" suffix is added when the value for one of the fields is not available yet. What should happen (and it working for me here) is that if there is no value for one of those fields listed in the format rule, after initial ajax loading of the image, it will have that "_upload_tmp" suffix, and then when you save the page, assuming you have selected something for those required format fields, the file will be renamed once again, now that it has the data it needs. 

BTW, I just tested with an Options fieldtype with a mixed case name, so there should be no problem there.

I am sure you've thought of this, but be aware that Options and Page Reference fields set to store multiple values will automatically use the first selected value.

Not sure where to go from here, but maybe you could start with a simple {$page->title} rule and if that works, add another field and see which one breaks it and we can investigate from there.

Share this post


Link to post
Share on other sites

@adrian, thanks, I've got it sorted. It was a typo in a field name on my part. I didn't realise it would drop the whole filename pattern rather than just the incorrect part, but once I corrected that, it's all good.

  • Like 1

Share this post


Link to post
Share on other sites
1 minute ago, Kiwi Chris said:

I didn't realise it would drop the whole filename pattern rather than just the incorrect part

Yeah, it's the only way to handle it really because that upload_tmp suffix is needed to trigger the later rename. Anyway, glad you got it sorted.

Share this post


Link to post
Share on other sites

@adrian I just came across this module for the first time and it works like a charm! Thank you!

  • Like 1

Share this post


Link to post
Share on other sites

Hi there. I am pretty new to processwire. Been using the module and it works perfectly!

I have one question. Sometimes when images are uploaded, from the gui, the module adds a "-1" is there a get around for this?

I basically am trying to keep the name of the file same for each different upload.

 

Thank you!

 

image.png

Edited by helin

Share this post


Link to post
Share on other sites

Hi @helin,

Sorry for the late response. This has annoyed me for a long time and while it might seem like an easy fix, it has eluded me several times. I have put in another concerted effort and I think I have a working solution, but it would be great if you could test before I commit to the repo. Please try the attached file and let me know. It should work regardless of whether you have the "Rename on Save" option checked, but please note that if you upload a replacement file for a single image field (max allowed 1 file), then the -1 will be appended until you save the page - this is simply because the other image still exists until you save the page, so the filename must be adjusted, but it should now be removed if there are no other conflicting filenames.

 

ProcessCustomUploadNames.module.php

Share this post


Link to post
Share on other sites

@helin - any chance you could test that attached version for me to confirm it's also working for you?

Share this post


Link to post
Share on other sites

Hey @adrian, it seems it's impossible to delete a rule. When I click the trash icon the rule disappears but I'm getting the following error on console and when I press the submit button the rule appears again.

JqueryCore.js?v=183:2 Uncaught RangeError: Maximum call stack size exceeded
    at String.replace (<anonymous>)
    at nt (JqueryCore.js?v=183:2)
    at Function.nt.matches (JqueryCore.js?v=183:2)
    at Function.filter (JqueryCore.js?v=183:2)
    at init.v.fn.<computed> [as children] (JqueryCore.js?v=183:2)
    at Object.toggle (inputfields.js?v=31e:178)
    at Object.focus (inputfields.js?v=31e:400)
    at inputfields.js?v=31e:401
    at completed (inputfields.js?v=31e:191)
    at Object.toggle (inputfields.js?v=31e:246)

 

Share this post


Link to post
Share on other sites

@PWaddict - I am not having any problems deleting a rule. Can you please investigate the error further - is it specific to a particular browser? Are you running the regular Uikit theme? Can you try debugging the deleteRow function in the module's js file to see if you can prevent the error?

Share this post


Link to post
Share on other sites
35 minutes ago, adrian said:

@PWaddict - I am not having any problems deleting a rule. Can you please investigate the error further - is it specific to a particular browser? Are you running the regular Uikit theme? Can you try debugging the deleteRow function in the module's js file to see if you can prevent the error?

ProcessWire 3.0.165 (with default Uikit admin theme)
Google Chrome 87.0.4280.66 (Official Build) (64-bit)

I did more tests and I can only delete the last rule. So, if I want to delete the 1st or the 3rd etc, first I have set it as the last one, press the submit button to save the order list and then I can delete it.

Also tested on Firefox 83.0 (64-bit) and I'm getting the following console error if I try to delete any rule except the last one:

Uncaught TypeError: $(...).val() is undefined
    <anonymous> https://mysite.test/site/modules/ProcessCustomUploadNames/ProcessCustomUploadNames.js?v=1.2.9:68
    jQuery 2
    <anonymous> https://mysite.test/site/modules/ProcessCustomUploadNames/ProcessCustomUploadNames.js?v=1.2.9:59
    jQuery 9
    <anonymous> https://mysite.test/site/modules/ProcessCustomUploadNames/ProcessCustomUploadNames.js?v=1.2.9:54
    jQuery 11

 

  • Like 1

Share this post


Link to post
Share on other sites

Thanks, that helps a lot. Should now be all sorted, along with a couple of other settings savings issues I just noticed. I have also included the fix I added for @helin's issue. Let me know how it goes for you.

 

  • Thanks 1

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 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!


    • By Robin S
      If your module has a lot of config fields you might want to divide them into groups inside a tabbed interface. Here is a demonstration module showing how this can be done.
      https://github.com/Toutouwai/ModuleConfigTabs

      Thanks to @kixe for providing my starting point in this forum topic.
×
×
  • Create New...