====== localexplorer Plugin ======

---- plugin ----
description: This plugin creates a localexplorer link directly to files stored in your local Windows system, including shared network storage.  It requires the Local Explorer Chrome or Edge extension plus the Windows integration module in order to work.
author     : Leonard Heyman
email      : lenehey@gmail.com
type       : Syntax 
lastupdate : 2023-08-12
compatible : Jack Jackrum
depends    : 
conflicts  : 
similar    : 
tags       : localexplorer

downloadurl: https://github.com/lenehey/dw_tpl_localexplorer/archive/refs/heads/main.zip
bugtracker : https://github.com/lenehey/dw_tpl_localexplorer/issues
sourcerepo : https://github.com/lenehey/dw_tpl_localexplorer
donationurl: 

screenshot_img : 
securityissue: 

----



===== Installation =====

I tested this and it seems to work, but no guarantees.  This requires both Local Explorer Chrome (or Edge) plugin and Windows integration modules, which I did not write and have no responsibility for.  They work for me, but use at your own risk!

:!: **External requirements:** This plugin requires the following additional components that must be installed separately: 
  * [[https://chrome.google.com/webstore/detail/local-explorer-open-file/eokekhgpaakbkfkmjjcbffibkencdfkl|Local Explorer Chrome plugin]]
  * Local Explorer integration module:  Read instructions [[http://www.vnprodev.com/browser-extensions/local-explorer-install.php|here]].

Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====

Links look like this:

''<nowiki>[[localexplorer>C:\Users\your_name\OneDrive\Documents\|Documents folder]]</nowiki>''

''<nowiki>[[localexplorer>C:\Users\your_name\OneDrive\Documents\book.pdf|Book in Documents Folder]]</nowiki>''

''<nowiki>[[localexplorer>S:\Department\Accounting\sales\EMEA.xlsx\|EMEA spreadsheet]]</nowiki>''


If you have the required Chrome or Edge plugin and the Windows integration module, the link should open the folder (or file) according to the path.


===== Syntax =====

''<nowiki>[[localexplorer></nowiki>//**path**//|**[//title//]**<nowiki>]]</nowiki>''

This is rendered to HTML as: 

''<nowiki><a href="localexplorer:</nowiki>//path//<nowiki>"></nowiki>//title//<nowiki></a></nowiki>''




===== Security =====

**Updated:**  A cross-Site-Scripting vulnerability was reported on 2023-08-14.  This issue was resolved on 08/14/23.  I updated the plugin to strip the double-quote (") character from the path and also to apply the rawurlencode() function before constructing the HTML link, which should resolve the security concern.  The current version should work correctly and securely.   --- [[user>lenehey|lenehey]] //2023-08-15 02:23//

===== Discussion =====

I realized now that this exact same result can be achieved using the built-in interwiki functionality.  To do this, add to to the ''interwiki.local.conf'' file in the ''conf'' folder the folloiwng line:

''lexp localexplorer:{NAME}''

If you don't like the default icon, you can upload an icon for your links.  If so, it needs to be called ''
lexp.png'', ''lexp.gif'', or ''lexp.svg''.

Format your links as follows:  ''**<nowiki>[[lexp></nowiki>**//path//**<nowiki>|[</nowiki>**//[title]//**<nowiki>]]</nowiki>**'' where the italicized text is replaced by your text and the //**[title]**// is optional (as indicated by the square brackets).

I'm leaving this plugin up because I think a lot of people might not be aware that you can get this functionality using Dokuwiki and the Local Explorer browser extension.  

 --- [[user>lenehey|lenehey]] //2023-08-17 21:12//