Jump to content
adrian

Custom Upload Names

Recommended Posts

I test it on a new page and getting the same problem. Having "Rename on Save" unchecked everything seems to be ok.

Are you sure that it's working for you with multiple repeater items and with "Rename on Save" checked?

  • Like 2

Share this post


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

Are you sure that it's working for you with multiple repeater items

That seems to be the issue - it seems one of my recent attempts to clean things up broke this part. I'll try to get it fixed soon. 

Thanks for all your testing of this module - it hasn't had any love for a long time and I have never actually used it with repeaters so it certainly needs it 🙂

  • Like 1

Share this post


Link to post
Share on other sites

Just a note here to say that repeater support is now fixed. A big thanks to @PWaddict for help testing these changes.

  • Like 3

Share this post


Link to post
Share on other sites

Can you completely remove the HTML entities? For example if on the text field I write: "Test" then the file will be renamed to: quot-test-quot.jpg instead of test.jpg.

  • Like 1

Share this post


Link to post
Share on other sites
36 minutes ago, PWaddict said:

Can you completely remove the HTML entities? For example if on the text field I write: "Test" then the file will be renamed to: quot-test-quot.jpg instead of test.jpg.

Yep, good catch - please try the latest version.

  • Thanks 1

Share this post


Link to post
Share on other sites

@PWaddict - I just committed another update which makes use of PW's core cleanBasename method for generating the final filename. I think this should be an improvement in certain situations. Please let me know if you have any problems with it.

Share this post


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

@PWaddict - I just committed another update which makes use of PW's core cleanBasename method for generating the final filename. I think this should be an improvement in certain situations. Please let me know if you have any problems with it.

It ignores the "Character replacements" from the InputfieldPageName module and on repeaters it replaces "Character replacements" and HTML entities with underscores. Please remove that update. The 1.2.2 version does the job perfect.

  • Like 1

Share this post


Link to post
Share on other sites
4 hours ago, PWaddict said:

It ignores the "Character replacements" from the InputfieldPageName module and on repeaters it replaces "Character replacements" and HTML entities with underscores. Please remove that update. The 1.2.2 version does the job perfect.

Thanks for noticing that - I have reverted that change and bumped the version number to 1.2.4 to make sure anyone who upgraded to 1.2.3 sees that there has been an update.

Share this post


Link to post
Share on other sites

Actually, I messed up that reversal, but I decided to investigate the issue you're having with 1.2.3 and I can't reproduce. This is what happens for me in a repeater - note that the ä is replaced with an "a" as expected. I don't think it should matter, but what version of PW are you running?

image.png.9acb3dc815cb30f0d95ba61685e05207.png

Share this post


Link to post
Share on other sites

@PWaddict - I know you'd like me to just revert to that previous version but I would like to figure out why it seems to be working ok for me and not you. Can you please post your settings for the rename rule and an example of a field value that is causing htmlentities to be replaced with underscores.

Share this post


Link to post
Share on other sites
1 hour ago, adrian said:

@PWaddict - I know you'd like me to just revert to that previous version but I would like to figure out why it seems to be working ok for me and not you. Can you please post your settings for the rename rule and an example of a field value that is causing htmlentities to be replaced with underscores.

On the regular field I'm using {$page->title}_{$file->mtime} + "Rename on Save".
On the repeater field I'm using {$filePage->my_text_field}_{$file->mtime} + "Rename on Save".

On the field value I tested with various combinations like: "Test щ" or "Test ä" but doesn't matter cause none of them are working,

Share this post


Link to post
Share on other sites
32 minutes ago, PWaddict said:

On the regular field I'm using {$page->title}_{$file->mtime} + "Rename on Save".
On the repeater field I'm using {$filePage->my_text_field}_{$file->mtime} + "Rename on Save".

On the field value I tested with various combinations like: "Test щ" or "Test ä" but doesn't matter cause none of them are working,

Weird, that filename format patter for me returns: test_a_1545255464.jpg which should be exactly what we expect - correct?

 

Share this post


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

Weird, that filename format patter for me returns: test_a_1545255464.jpg which should be exactly what we expect - correct?

yep

Share this post


Link to post
Share on other sites

This is interesting:

image.png.b757dacd27cbe0f32933444800b2ac05.png

Are you seeing the first, rather than the second result?

See the last commit where those booleans are passed to the cleanBasename() method: https://github.com/adrianbj/CustomUploadNames/commit/9428a18c4cf67a40c7ef6bd6b63ae600a28086e3

Could you please check that the version you are using has those lines and also please test that code in the Tracy console:

$pageFiles = new Pagefiles($page);

d($pageFiles->cleanBasename('"Test ä".png'));
d($pageFiles->cleanBasename('"Test ä".png', false, true, true));

 

Share this post


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

Could you please check that the version you are using has those lines

Yep I have the 1.2.4 and it has those lines.

 

15 minutes ago, adrian said:

please test that code in the Tracy console

Here are the results:

tracy.jpg.59645d49f289bab8aae44b060c5128c7.jpg

Share this post


Link to post
Share on other sites

@PWaddict - thanks for checking that code in the Console, but it looks the same as what I am seeing, so I can't figure out why you're getting a different result returned from the module. 

Not sure where to go from here other than asking you to test on another PW install.

Share this post


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

it looks the same as what I am seeing

It's not the same. On the 2nd command the result for you is test_a.png and for me test.png.

  • Like 1

Share this post


Link to post
Share on other sites
10 minutes ago, PWaddict said:

It's not the same. On the 2nd command the result for you is test_a.png and for me test.png.

Sorry I didn't catch that 🙂

So for some reason your install is behaving differently. I think I have narrowed it down to multibyte support or iconv. Could you please run these in the console and let me know what you get:

d(function_exists("mb_internal_encoding"));
d(function_exists("\\iconv"));

 

Share this post


Link to post
Share on other sites

Thanks, although not what I was hoping for 🙂

I don't know how to debug this without being able to access your system. I am pretty sure it's in $sanitizer->nameFilter() which is called by many other methods. Have you manually edited the PageName character replacements? It seems that if I remove the needed ones from that and I disable iconv, then I can get the same result you are getting. 

Would you be up for trying to dig into that nameFilter method and see where it's failing for you? I think it's somewhere in this block: https://github.com/processwire/processwire/blob/a0570bb2a0919ddc38487f1adbb190f9f9ab90f2/wire/core/Sanitizer.php#L171-L186

Share this post


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

 


$pageFiles = new Pagefiles($page);

d($pageFiles->cleanBasename('"Test ä".png'));
d($pageFiles->cleanBasename('"Test ä".png', false, true, true));

I've installed TracyDebugger on live server and the results from the above code are the same as yours. The problem is happening only on localhost (XAMPP).

Share this post


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

Have you manually edited the PageName character replacements?

No.

 

27 minutes ago, adrian said:

Would you be up for trying to dig into that nameFilter method and see where it's failing for you?

I'm not sure how to test it.

Share this post


Link to post
Share on other sites

Could be the problem caused by Windows? I have the same installation on localhost (Windows) and on live server (Linux). Have you tried on localhost (Windows)?

Share this post


Link to post
Share on other sites
11 minutes ago, PWaddict said:

Have you tried on localhost (Windows)?

I don't have access to a Windows machine dev environment at the moment. It might be related I suppose. I would have thought this issue would have come up before though because the cleanBasename method is what PW uses when uploading images, which is the reason I'd like to stay with this approach if I can, rather than the old pageName I was using before. 

In terms of how you could debug this, in that block of code I linked to, I'd want to know that mb_strpos, mb_eregi_replace and iconv calls are returning the same values on the Windows box that they are on linux. 

I would try this:

        if($beautify && $needsWork) {
            if($beautify === self::translate && $this->multibyteSupport) {
                $value = mb_strtolower($value);

                if(empty($replacements)) {
                    $configData = $this->wire('modules')->getModuleConfigData('InputfieldPageName');
                    $replacements = empty($configData['replacements']) ? InputfieldPageName::$defaultReplacements : $configData['replacements'];
                }

                foreach($replacements as $from => $to) {
                    if(mb_strpos($value, $from) !== false) {
                        bd($from .' => ' . $to, $value);
                        $value = mb_eregi_replace($from, $to, $value);
                        bd($value);
                    }
                }
            }

            if(function_exists("\\iconv")) {
                $v = iconv("UTF-8", "ASCII//TRANSLIT//IGNORE", $value);
                if($v) {
                    bd($value, 'ICONV');
                    $value = $v;
                }
            }
            $needsWork = strlen(str_replace($allowed, '', $value));
        }

which should result in something like this which shows the replacement ä => a that is being made and with the final filename and whether the iconv call changes it further or not.

image.png.e67c79e3ac49e14ded885b4d55a57da4.png

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By apeisa
      Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.
      ***
      Latest screencast: http://www.screencas...73-ab3ba1fea30c
      Grab the code: https://github.com/teppokoivula/AdminBar
      ***
      I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.
      I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4
      When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.
      I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.
      ***
      When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:
      if($this->redirectUrl) $this->session->redirect($this->redirectUrl); if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE else $this->session->redirect("./?id={$this->page->id}");   and...
      if(!empty($_GET['modal'])) { $form->attr('action', './?id=' . $this->id . '&modal=true'); } else { $form->attr('action', './?id=' . $this->id); // OLD LINE }  
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
    • By nbcommunication
      I've spent the last while experimenting with srcset implementation - and PageimageSrcset is the result:
      PageimageSrcset
      Provides configurable srcset and sizes properties/methods for Pageimage.
      Overview
      The main purpose of this module is to make srcset implementation as simple as possible in your template code. It does not handle images rendered in CKEditor or similar fields.
      For an introduction to srcset and sizes, please read this Mozilla article about responsive images.
      Pageimage::srcset()
      // The property, which uses the set rules in the module configuration $srcset = $image->srcset; // A method call, using a set rules string // Delimiting with a newline (\n) would also work, but not as readable $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x"); // The same as above but using an indexed/sequential array $srcset = $image->srcset([ "320", "480", "640x480 768w", "1240", "2048 2x", ]); // The same as above but using an associative array // No rule checking is performed $srcset = $image->srcset([ "320w" => [320], "480w" => [480], "768w" => [640, 480], "1240w" => [1240], "2x" => [2048], ]); // Use the default set rules with portrait images generated for mobile/tablet devices $srcset = $image->srcset(true); // Return the srcset using all arguments $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x", [ "portrait" => "320, 640", ]); // The set rules above are a demonstration, not a recommendation! Image variations are only created for set rules which require a smaller image than the Pageimage itself. On large sites this may still result in a lot of images being generated. If you have limited storage, please use this module wisely.
      Portrait Mode
      In many situations, the ratio of the image does not need to change at different screen sizes. However, images that cover the entire viewport are an exception to this and are often the ones that benefit most from srcset implementation.
      The main problem with cover images is that they need to display landscape on desktop devices and portrait when this orientation is used on mobile and tablet devices.
      You can automatically generate portrait images by enabling portrait mode. It is recommended that you use this in combination with Pageimage::focus() so that the portrait variations retain the correct subject.
      The generated variations are HiDPI/Retina versions. Their height is determined by the portrait ratio (e.g. 9:16). Variations are always generated, regardless of whether the original image is smaller. Upscaling is disabled though, so you may find that some variations are actually smaller than they say they are in their filename.
      The sizes attribute should be used when portrait mode is enabled. Pageimage::sizes will return (orientation: portrait) and (max-width: {maxWidth}px) 50vw by default, which handles the use of these images for retina devices. The maximum width used in this rule is the largest set width.
      Pageimage::sizes()
      There is no option to configure default sizes because in most cases 100vw is all you need, and you do not need to output this anyway as it is inferred when using the srcset attribute. You can use the method for custom sizes though:
      // The property $sizes = $image->sizes; // Returns 100vw in most cases // Returns '(orientation: portrait) and (max-width: {maxWidth}px)50vw' if portrait mode enabled // A method call, using a mixture of integer widths and media query rules // Integer widths are treated as a min-width media query rule $sizes = $image->sizes([ 480 => 50, "(orientation: portrait) and (max-width: 640px)" => 100, 960 => 25, ]); // (min-width: 480px) 50vw, (orientation: portrait) and (max-width: 640px) 100vw, (min-width: 960px) 25vw // Determine widths by UIkit 'child-width' classes $sizes = $image->sizes([ "uk-child-width-1-2@s", "uk-child-width-1-3@l", ]); // (min-width: 640px) 50vw, (min-width: 1200px) 33.33vw // Determine widths by UIkit 'width' classes $sizes = $image->sizes([ "uk-width-1-2@m", "uk-width-1-3@xl", ]); // (min-width: 960px) 50vw, (min-width: 1600px) 33.33vw // Return the portrait size rule $sizes = $image->sizes(true); // (orientation: portrait) and (max-width: {maxWidth}px) 50vw // The arguments above are a demonstration, not a recommendation! Pageimage::render()
      This module extends the options available to this method with:
      srcset: When the module is installed, this will always be added, unless set to false. Any values in the formats described above can be passed. sizes: Only used if specified. Any values in the formats described above can be passed. uk-img: If passed, as either true or as a valid uk-img value, then this attribute will be added. The srcset attribute will also become data-srcset. Please refer to the API Reference for more information about this method.
      // Render an image using the default set rules echo $image->render(); // <img src='image.jpg' alt='' srcset='{default set rules}'> // Render an image using custom set rules echo $image->render(["srcset" => "480, 1240x640"]); // <img src='image.jpg' alt='' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w'> // Render an image using custom set rules and sizes // Also use the `markup` argument echo $image->render("<img class='image' src='{url}' alt='Image'>", [ "srcset" => "480, 1240", "sizes" => [1240 => 50], ]); // <img class='image' src='image.jpg' alt='Image' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 1240px) 50vw'> // Render an image using custom set rules and sizes // Enable uk-img echo $image->render([ "srcset" => "480, 1240", "sizes" => ["uk-child-width-1-2@m"], "uk-img" => true, ]); // <img src='image.jpg' alt='' data-uk-img data-srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 960px) 50vw'> // Render an image using portrait mode // Default rule sets used: 320, 640, 768, 1024, 1366, 1600 // Portrait widths used: 320, 640, 768 // Original image is 1000px wide // Not possible to use portrait mode and custom sets or portrait widths in render() // Sizes attribute automatically added echo $image->render(["srcset" => true]); // <img src='image.jpg' alt='' srcset='image.320x569-srcset-hidpi.jpg 320w, image.640x1138-srcset-hidpi.jpg 640w, image.768x1365-srcset-hidpi.jpg 768w, image.jpg 1024w' sizes='(orientation: portrait) and (max-width: 768px) 50vw'> Configuration
      To configure this module, go to Modules > Configure > PageimageSrcset.
      Set Rules
      These are the default set rules that will be used when none are specified, e.g. when calling the property: $image->srcset.
      Each set rule should be entered on a new line, in the format {width}x{height} {inherentwidth}w|{resolution}x.
      Not all arguments are required - you will probably find that specifying the width is sufficient for most cases. Here's a few examples of valid set rules and the sets they generate:
      Set Rule Set Generated Arguments Used 320 image.320x0-srcset.jpg 320w {width} 480x540 image.480x540-srcset.jpg 480w {width}x{height} 640x480 768w image.640x480-srcset.jpg 768w {width}x{height} {inherentwidth}w 2048 2x image.2048x0-srcset.jpg 2x {width} {resolution}x How you configure your rules is dependent on the needs of the site you are developing; there are no prescriptive rules that will meet the needs of most situations. This article gives a good overview of some of the things to consider.
      When you save your rules, a preview of the sets generated and an equivalent method call will be displayed to the right. Invalid rules will not be used, and you will be notified of this.
      Portrait Mode
      Set Widths
      A comma limited list of widths to create HiDPI/Retina portrait variations for.
      Crop Ratio
      The portrait ratio that should be used to crop the image. The default of 9:16 should be fine for most circumstances as this is the standard portrait ratio of most devices. However, you can specify something different if you want. If you add a landscape ratio, it will be switched to portrait when used.
      Any crops in the set rules ({width}x{height}) are ignored for portrait mode variations as this ratio is used instead.
      UIkit Widths
      If your website theme uses UIkit, you can pass an array of UIkit width classes to Pageimage::sizes to be converted to sizes. The values stored here are used to do this. If you have customised the breakpoints on your theme, you should also customise them here.
      Please note that only 1- widths are evaluated by Pageimage::sizes, e.g. uk-width-2-3 will not work.
      Remove Variations
      If checked, the image variations generated by this module are cleared on Submit. On large sites, this may take a while. It makes sense to run this after you have made changes to the set rules.
      Image Suffix
      You will see this field when Remove Variations is checked. The value is appended to the name of the images generated by this module and is used to identify variations. You should not encounter any issues with the default suffix, but if you find that it conflicts with any other functionality on your site, you can set a custom suffix instead.
      Debug Mode
      When this is enabled, a range of information is logged to pageimage-srcset.
      PageimageSrcsetDebug.js is also added to the <head> of your HTML pages. This will console.log a range of information about the images and nodes using srcset on your page after a window.onresize event is triggered. This can assist you in debugging your implementation.
      The browser will always use the highest resolution image it has loaded or has cached. You may need to disable browser caching to determine whether your set rules are working, and it makes sense to work from a small screen size and up. If you do it the other way, the browser is going to continue to use the higher resolution image it loaded first.
      UIkit Features
      This module implements some additional features that are tailored towards UIkit being used as the front-end theme framework, but this is not required to use the module.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. ProcessWire >= 3.0.123 is required to use this module.
×
×
  • Create New...