FileDownload R issues with path

Airiam · February 27, 2024, 4:16pm

I’m attempting to use FileDownload R with the FileDownloadLink call. No matter what I do the error log always displays the error 717 &getDir parameter expects a correct dir path. <b>""</b> is given.

The link in it’s default state works and appears on the page and allows the file to be downloaded, however with the error persisting it won’t let me add any additional parameters to the call so I can’t give it a template etc.

My call currently looks like this

[[!FileDownloadLink?
&getFile=`downloads/training/guides/pdf/theMacHealthCheckGuide/TheMacHealthCheckGuide.zip`
]]

This shows the link and allows it to be downloaded but still throws the error.

Any help here would be greatly appreciated, I’ve googled and tried to troubleshoot for a good 24 hours but haven’t gotten anywhere.

jako · February 27, 2024, 5:19pm

The path in getFile has to be relative to the base path of MODX (since it uses the media source 0).

You can use the default path placeholder of MODX: {base_path}, {core_path} or {assets_path}.

My tests work well on a dev machine with the following property:

&getFile=`{base_path}assets/test/test.png`

halftrainedharry · February 27, 2024, 5:54pm

I think this error always gets output when no &getDir property is defined.
But the code should still work and you should still be able to add additional properties.

If no &getDir property is set, the value defaults to [''].

github.com

Jako/FileDownloadR/blob/ee93c1f163b955d384cd2548cb164b7963acad5f/core/components/filedownloadr/src/FileDownloadR.php#L410


      
          // Clear previous output for subsequent snippet calls
          $this->_output = [
              'rows' => '',
              'dirRows' => '',
              'fileRows' => ''
          ];
          $this->_error = [];
          
          $config = $this->replacePathProperties($config);
          
          $config['getDir'] = (!empty($config['getDir'])) ? $this->checkPath($config['getDir']) : [''];
          $config['getFile'] = (!empty($config['getFile'])) ? $this->checkPath($config['getFile']) : '';
          $config['origDir'] = $config['getDir'];
          
          if (!empty($config['uploadFile'])) {
              $mimes = new MimeTypes;
              $fileTypes = [];
              $fileExtensions = [];
              if (!empty($config['uploadFileTypes'])) {
                  foreach ($config['uploadFileTypes'] as $uploadFileType) {
                      if ($mimes->getExtension($uploadFileType)) {

The value [''] is not empty, so the error message gets logged.

github.com

Jako/FileDownloadR/blob/ee93c1f163b955d384cd2548cb164b7963acad5f/core/components/filedownloadr/src/FileDownloadR.php#L681


      
          /**
           * Retrieve the content of the given path.
           *
           * @return array All contents in an array
           */
          public function getContents()
          {
              $this->modx->invokeEvent('OnFileDownloadLoad');
          
              $dirContents = [];
              if (!empty($this->getOption('getDir')) || $this->mediaSource) {
                  $dirContents = $this->getDirContents($this->getOption('getDir'));
                  if (!$dirContents) {
                      $dirContents = [];
                  }
              }
              $fileContents = [];
              if (!empty($this->getOption('getFile'))) {
                  $fileContents = $this->getFileContents($this->getOption('getFile'));
                  if (!$fileContents) {
                      $fileContents = [];

Airiam · February 27, 2024, 9:14pm

Sure enough, if I add the &getDir property and define it I no longer get the error. However even using the {} notation with base_path (not seen the curly brackets used before) I still can’t add additional properties.

So now my call looks like this:

[[!FileDownloadLink?
&getDir=`{base_path}downloads/training/guides/pdf/themacHealthCheckGuide`
&getFile=`{base_path}downloads/training/guides/pdf/theMacHealthCheckGuide/TheMacHealthCheckGuide.zip`
&tplCode=`
<div class="button-container">
      <a class="button" href="[[+link]]" download>Download the Guide here</a>
  </div>`
]]

The &tplCode never gets rendered and I just get the ‘default’ option of the filename as a link on the page itself.

I get the same result if I paste the example code from the manual page on the MODX site for FileDownloadLink but change the path to mine. I get the link but not the template code.

halftrainedharry · February 27, 2024, 9:33pm

There exists no property tplCode.

Use the property with the name tpl.
Then either put the template code in a chunk or use @CODE (or @INLINE) at the start of the markup:

&tpl=`@CODE <div class="button-container"><a class="button" href="[[+link]]" download>Download the Guide here</a></div>`

jako · February 28, 2024, 9:22am

The logging will be fixed in the next version. Only a not found path that is not empty will be logged.

Airiam · February 28, 2024, 9:54am

Putting it in the chunk and using the &tpl property worked. However it was not clear from the documentation that this was the case: https://docs.modx.com/3.x/en/extras/filedownload-r/filedownload-r.filedownloadlink

Thanks for getting me on track.

halftrainedharry · February 28, 2024, 10:00am

The documentation you linked doesn’t seem to be up-to-date.

Use this one instead:

https://jako.github.io/FileDownloadR/usage/#filedownloadlink

Airiam · February 28, 2024, 10:15am

Thanks so much - so much clearer now!

system · March 1, 2024, 10:15am

This topic was automatically closed 2 days after discussion ended and a solution was marked. New replies are no longer allowed. You can open a new topic by clicking the link icon below the original post or solution and selecting “+ New Topic”.