osTicket Plugin: Allows inline view of attachments
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Attachment Preview

An osTicket plugin allowing inlining of Attachments, works with PHP5.3+ and osTicket 1.9+

Build Status

#How it looks: agent_view

Current features:

  • PDF Files attachments are embedded as full PDF <object> in the entry.
  • Images inserted as normal <img> tags. Supported by most browsers: png,jpg,gif,svg,bmp
  • Text files attachments are inserted into using <pre> (If enabled).
  • HTML files are filtered and inserted (If enabled).
  • Youtube links in comments can be used to create embedded <iframe> players. (if enabled)
  • HTML5 Compatible video formats attached are embedded as <video> players. (if enabled)
  • All modifications to the DOM are now performed on the server.
  • Admin can choose the types of attachments to inline, and who can inline them.
  • Default admin options are embed "PDF's & Images" only for "Agents".
  • Plugin API: allows other plugins to manipulate the DOM without adding race conditions or multiple re-parses.

To Install:

  1. Simply git clone https://github.com/clonemeagain/attachment_preview.git /includes/plugins/attachment_preview Or extract latest-zip into /includes/plugins/attachment_preview
  2. Navigate to: https://your.domain/support/scp/plugins.php?a=add to add a new plugin.
  3. Click "Install" next to "Attachment Inline Plugin"
  4. Now the plugin needs to be enabled & configured, so you should be seeing the list of currently installed plugins, pick the checkbox next to "Attachment Inline Plugin" and select the "Enable" button.
  5. Now you can configure the plugin, click the link "Attachment Inline Plugin" and choose who the plugin should be activated for, or keep the default.

To Remove:

Navigate to admin plugins view, click the checkbox and push the "Delete" button.

The plugin will still be available, you have deleted the config only at this point, to remove after deleting, remove the /plugins/attachment_preview folder.

How it works:

Latest in Wiki

  • Essentially it's simple, when enabled, and a ticket page is viewed, an output buffer is created which waits for the page to be finished rendering by osTicket. (Using php's register_shutdown_function & ob_start)
  • The plugin then uses a DOMDocument and adds a new DOMElement after each attachment, inlining them. PDF's become <object>'s, PNG's become <img> etc.

The plugin has several administratively configurable options, including, but not limited to:

  • What to inline (PDF/Image/Youtube/Text/HTML etc)
  • The maximum size of attachments to inline.
  • How many to inline, attachments after that are still inlineable, but the Agent has to press a "Show Attachment" button (translateable).
  • We now support changing the original attachment link into a "New Tab", so there is an option for that.

The plugin is completely self-contained, so ZERO MODS to core are required. You simply clone the repo or download the zip from github and extract into /includes/plugins/ which should make a folder: "attachment_preview", but it could be called anything.

TODO: