adrian

Custom Upload Names

Recommended Posts

I just committed an update that brings full support for repeater fields (images and images embedded into RTE fields inside repeaters).

I also fixed a bug with the new core cropping functionality if you set a filename format that is not available on file upload, such as $file->description.

There were some significant changes to hooks and logic to get the repeaters working, so please test and let me know if you come across any problems.

  • Like 5

Share this post


Link to post
Share on other sites

Adrian thanks for this module.

I'm having some problems with images inside repeater. It acts very strange. It gives errors when i try to add o remove images from the repeater field, and then save the page. And if i try to add a new repeater item, the image field in it is already populated with an image i thought i had deleted. 

I attach some screenshots with various errors i'm receiving.

Let me know how can i help to make this more clear.

post-2122-0-77584400-1427737342_thumb.pn

post-2122-0-29706400-1427737355_thumb.pn

post-2122-0-17649700-1427737362_thumb.pn

Share this post


Link to post
Share on other sites

Sorry about the errors you are seeing. Repeater support is very new, but I am not seeing any issues at my end. Can you please let me know the filename format you defined. Also what other field types do you have on the page and also in the repeater. Do you have more than one repeater field on the page. What version of PW are you using.

Also, would you mind trying a little debugging for me - try logging the value of $this->pages and also $field just before line 312.

Share this post


Link to post
Share on other sites

Sure, Adrian.

This is the filename format: {$page->title}-##

These are the fields on that template:

- the field slideshow_repeater, that gives those problems has an image_field (that has maximum files allowed = 1) and a url field. 

- an image field with maximum files allowed = 1 (i had no problems with this field)

- an image field with maximum files allowed = 0 (i had no problems with this field)

- 2 files field

- a lot of text and textarea fields

- all the seo fields from the Seo Module

There are no other repeaters on that template (i'm attaching a screenshot).

I'm also using the image extra module on InputfieldImage and InputfieldFile

I'm using PW 2.5.23 dev

I'm sorry, i'm not so sure how to log the errors you asked, i'm not a php developer, so i tried with error_log() and i just get "Pages" for $this->pages and i get "1.jpg" or "2.jpg" etc for $this->pages->get($pageid)->$field

Thanks a lot!

post-2122-0-95213100-1427740880_thumb.pn

Share this post


Link to post
Share on other sites

Thanks for all that info - I tried to replicate your image fields setup but still can't get the error.

Sorry I didn't ask for quite the correct things for the log output.

Can you please try replacing:

//filename format can support $page, $template, $field, and $file variables in the format as defined in the module config settings
//if repeater page, need to use parent page for determining name
$page = $repeaterPage !== null ? $repeaterPage->getForpage() : $this->pages->get($pageid);
$field = $this->fields->get($fieldid);
$template = $page->template;
$file = $this->pages->get($pageid)->$field->get("name={$path_parts['basename']}");

with:

//filename format can support $page, $template, $field, and $file variables in the format as defined in the module config settings
//if repeater page, need to use parent page for determining name
error_log('pageid: ' . $pageid);
$page = $repeaterPage !== null ? $repeaterPage->getForpage() : $this->pages->get($pageid);
error_log('page->id: ' . $page->id);  
error_log('page->name: ' . $page->name);                
$field = $this->fields->get($fieldid);
error_log('fieldid: ' . $fieldid);  
error_log('field->name: ' . $field->name);         
$template = $page->template;
error_log('template->name: ' . $template->name);
$file = $this->pages->get($pageid)->$field->get("name={$path_parts['basename']}");

and send me all the logged output.

Hopefully that will help me figure out where the issue might be.

Share this post


Link to post
Share on other sites

These are the logged errors in a page with two repeater items, one image per each:

pageid: 1372
page->id: 1053
page->name: digital-compositing-nuke
fieldid: 98
field->name: single_image
template->name: corso
pageid: 1373
page->id: 1053
page->name: digital-compositing-nuke
fieldid: 98
field->name: single_image
template->name: corso
pageid: 1373
page->id: 1373
page->name: 1427738337-12-1
fieldid: 120
field->name: cover_image
template->name: repeater_slideshow

I'm not sure, but maybe there is something strange with this: "page->name: 1427738337-12-1" (that's not the page name), and this "field->name: cover_image" because cover_image is not a field inside the repeater, it's outside. 

If it can help you I can give you access to the admin page, or to the project directories.

Thanks!

Share this post


Link to post
Share on other sites

Thanks for debug report - I was able to reproduce the problem here and I have committed a fix.

I hope I haven't broken anything else - it's a little complicated dealing with repeaters sometimes :)

Please let me know if it works for you and if you find any other issues.

BTW, I am assuming you have "Rename on Save" checked - that seemed to be when the issue showed up for me, although not always.

I also improved the behavior for checking existing numbered suffixes on the same main page, so now you won't end up with two images of the same filename, one inside a repeater and one on the main page, which was possible before.

  • Like 1

Share this post


Link to post
Share on other sites

Hi Adrian,

I'm wondering if it's possible to use this with Form Builder - which I've set to automatically create pages from submissions. When I set up a rule to only look at the page template (of the page being created) and two image fields my FB form starts to give me server 500 errors. If I remove the rule my FB form starts working again.

Cheers

Marty

Share this post


Link to post
Share on other sites

Hey Marty,

I am not a Formbuilder user so I don't know all the ins and outs, but I just set up a form and tested with CustomUploadNames and the page was created and the filename was changed as it should have been.

I have a feeling because CUN and FB both have so many config options, it might be just the combination you have that is causing problems.

Perhaps you could export the form for me to test and also take a screenshot of your CUN rule so I can duplicate.

I am sure we can get it sorted out for you.

Share this post


Link to post
Share on other sites

Hi Adrian,

I've got a problem when using fields in the filename format that are populated at the same time as the upload field (PDF in my case). The format looks like this:

customer-{$page->customer_id}

When a new page is created, the user fills in a value into the customer_id field and then uploads a PDF, which should get renamed. However, the value inside customer_id is not respected, as the PDF gets renamed right after upload and before hitting Save. A click on Save also doesn't rename it again.

I remember this worked a couple of versions ago, but not anymore. Did you change something in that area?

Using "Rename on Save" isn't an option as I need the filename to stay the same and not add a -1 suffix every second save.

Share this post


Link to post
Share on other sites

Sorry about that @charger. I had to change on of the hooks when I added support for repeaters which resulted in the issue you saw.

It should be fixed now and actually the new method is better and more reliable in other situations too.

Please grab the latest version and let me know.

On another note, I am curious about your comment regarding the -1 suffix on every second save - that actually shouldn't happen with this module, so if you are seeing that, please let me know and I'll investigate further. That said, I avoid the "Rename on Save" option whenever possible, so not suggesting you should use it, but I do want to make sure that using it doesn't result in the numbered suffix.

Thanks for reporting this.

Share this post


Link to post
Share on other sites

Thanks for the quick update, it again works as expected!

The -1 suffix still happens though with the "Rename on Save" option enabled. So whenever I hit Save, the filename alternates between having the suffix and not.

Let me know if you need other specific info.

Share this post


Link to post
Share on other sites

Glad to hear that it's working again for you!

I am still baffled about the -1 suffix with "Rename on Save" though. Could you maybe post screenshots of your settings for this module as well as letting me know the settings for your PDF field, eg:

  • Max Files Allowed
  • Overwrite existing files

I have tried lots of different combinations and it keeps the filename without the numbered suffix for me. Any chance you are on a Windows server - just wondering if maybe there is a directory separator issue.

Is there only one files field on the page? If it allows more than one file to be uploaded, are you actually still only uploading one or are there several?

Is there anything else you can think of that might contribute to this?

Thanks!

EDIT: One other thing to check - it there any chance that there is an extra file in the page's assets/files/1234 directory. Perhaps when it wasn't being renamed correctly I duplicate was left over - this would cause the behavior you are seeing, so please empty the files folder and try again. And/or try on a new page where you know the files folder is empty / without duplicates.

Share this post


Link to post
Share on other sites

I've attached the screenshot of my settings.

The PDF allows max one file and does overwrite existing files.

There's also just this file field on the page.

I created multiple new pages to make sure there are no leftover duplicates in the assets/files folder.

The website is not hosted on a Windows server.

Hmm.. I don't have any clue what else could cause it.

post-2284-0-23987200-1432129258_thumb.pn

Share this post


Link to post
Share on other sites

I noticed that the module also renames the files of a language pack during upload (if no fields are listed under Enabled Fields). Maybe this should be prevented by default.

Share this post


Link to post
Share on other sites

I noticed that the module also renames the files of a language pack during upload (if no fields are listed under Enabled Fields). Maybe this should be prevented by default.

Thanks for reporting. I have fixed this. I was thinking about disabling the module from affecting any pages under the admin, but thought some users may store some settings type pages, so for the moment I have just excluded pages with the "language" template.

Please let me know if you have any problems.

Share this post


Link to post
Share on other sites

Good day, Adrian!

I am adding images to an ImageField with CustomUploadNames hook enabled via API like this:

$images->add($file_path);

"Maximum files allowed" = 1. If "Formatted value" is set to automatic I get this error:

Error: Call to a member function getVariations() on a non-object (line 245 of /var/www/***/site/modules/ProcessCustomUploadNames/ProcessCustomUploadNames.module)

If "Formatted value" is set to Array of items, there is no error. Am I doing something wrong or is it a bug?

  • Like 1

Share this post


Link to post
Share on other sites

Hi Ivan,

Thanks for reporting that - it should be fixed in the version I just committed.

Please let me know how it goes.

  • Like 2

Share this post


Link to post
Share on other sites

This issue turned out to be related to this module. In short: As long as Custom Upload Names is installed, I get a fatal error when I try to view an entry within the Entries tab within a FormBuilder form.

  • Like 3

Share this post


Link to post
Share on other sites

Sorry everyone for the delay on fixing this - I was on vacation. It was related to a recent change to prevent it affecting language file uploads. 

Please let me know if anyone still has any issues.

Share this post


Link to post
Share on other sites

Dear Adrian,

I have strange issue with pages which have numbers and hyphens in $page->name (ex. foret-17).

Each save one of pictures becomes empty with error "file cannot be displayed". That mean, if I save page 10 times it lost 10 images.

After changing page name everything working fine.

  • Like 1

Share this post


Link to post
Share on other sites

Hi Alexander,

I just tried to replicate here and can't seem to. Could you maybe post some screenshots of your CUN settings and also the tree of pages. Or better yet can you set up an example on lightning.pw so I can see the issue in action?

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 Anssi
      A simple module to enable easy navigation between the public and the admin side of the site. After installation a green bar will appear to the upper side of the screen, containing a few navigation elements and displaying the PW version number.
      Heavily inspired by @apeisa's great AdminBar (Thanks!). I needed a bit simpler tool for my projects and as a result, this was made. Available on GitHub .

    • By Sebi
      I've created a small module which lets you define a timestamp after which a page should be accessible. In addition you can define a timestamp when the release should end and the page should not be accessable any more.
      Github: https://github.com/Sebiworld/PageAccessReleasetime
      Usage
      PageAccessReleasetime can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules
      After that, you will find checkboxes for activating the releasetime-fields at the settings-tab of each page. You don't need to add the fields to your templates manually.
      Check e.g. the checkbox "Activate Releasetime from?" and fill in a date in the future. The page will not be accessable for your users until the given date is reached.
      If you have $config->pagefileSecure = true, the module will protect files of unreleased pages as well.
      How it works
      This module hooks into Page::viewable to prevent users to access unreleased pages:
      public function hookPageViewable($event) { $page = $event->object; $viewable = $event->return; if($viewable){ // If the page would be viewable, additionally check Releasetime and User-Permission $viewable = $this->canUserSee($page); } $event->return = $viewable; } To prevent access to the files of unreleased pages, we hook into Page::isPublic and ProcessPageView::sendFile.
      public function hookPageIsPublic($e) { $page = $e->object; if($e->return && $this->isReleaseTimeSet($page)) { $e->return = false; } } The site/assets/files/ directory of pages, which isPublic() returns false, will get a '-' as prefix. This indicates ProcessWire (with activated $config->pagefileSecure) to check the file's permissions via PHP before delivering it to the client.
      The check wether a not-public file should be accessable happens in ProcessPageView::sendFile. We throw an 404 Exception if the current user must not see the file.
      public function hookProcessPageViewSendFile($e) { $page = $e->arguments[0]; if(!$this->canUserSee($page)) { throw new Wire404Exception('File not found'); } } Additionally we hook into ProcessPageEdit::buildForm to add the PageAccessReleasetime fields to each page and move them to the settings tab.
      Limitations
      In the current version, releasetime-protected pages will appear in wire('pages')->find() queries. If you want to display a list of pages, where pages could be releasetime-protected, you should double-check with $page->viewable() wether the page can be accessed. $page->viewable() returns false, if the page is not released yet.
      If you have an idea how unreleased pages can be filtered out of ProcessWire selector queries, feel free to write an issue, comment or make a pull request!
    • By David Karich
      Thanks to the great Pro module "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use this module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      With this proof of concept I have created a module which adds the feature to copy a repeater item to the clipboard so that you can paste this item to another page with the same repeater field. The module has been developed very rudimentarily so far. It is currently not possible to copy nested items. There is also no check of Min/Max. You can also only copy items that have the same field on different pages. And surely you can solve all this more elegantly with AJAX. But personally I lack the deeper understanding of the repeaters. Also missing on the Javascript side are event triggers for the repeaters, which would make it easier. Like e.g. RepeaterItemInitReady or similar.
      it would be great if @ryan would implement this functionality in the core of RepeaterMatrix. I think he has better ways to implement this. Or what do you think, Ryan?
      Everybody is welcome to work on this module and improve it, if it should not be integrated into the matrix core. Therefore I put it for testing and as download on GitHub: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDublicate
      You can best see the functionality in the screencast: 
       
    • By anderson
      Hi,
      Please take a look at this:
      https://templatemag.com/demo/Good/
      The upper nav bar, including dropdowns like "pages" and "portfolios", what do you call this whole thing? At first I guess it's called "dropdown nav bar", but seems not.
      AND of course, what's the simplest way/module to achieve this in PW?
      Thanks in advance.
    • By Sebi2020
      Hey, I'm new and I created a simple module for tagging pages because I didn't found a module for it (sadly this is not a core feature). This module is licensed under the GPL3 and cames with absolutly no warranty at all. You should test the module before using it in production environments. Currently it's an alpha release. if you like the module or have ideas for improvements feel free to post a comment. Currently this fieldtype is only compatible with the Inputfield I've created to because I haven't found  an Inputfield yet, that returns arrays from a single html input.
      Greetings Sebi2020
      FieldtypeTags.zip.asc
      InputfieldTagify.zip
      InputfieldTagify.zip.asc
      FieldtypeTags.zip