You are here

readme.txt in TinyBrowser 7

Same filename in this branch
  1. 7 README.txt
  2. 7 tinybrowser/readme.txt
Non-displayable characters.

File

tinybrowser/readme.txt
View source
  1. TinyBrowser 1.41 - A TinyMCE file browser (C) 2008 Bryn Jones
  2. (author website - http://www.lunarvis.com)
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 3 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see .
  13. TinyBrowser Features:
  14. =====================
  15. - Integrates as a custom file browser within TinyMCE for image, media and 'all'
  16. file types, or can work in stand-alone mode
  17. - Adobe Flash based file uploader, supporting multiple file selection and upload
  18. with file type and size filtering (permission based)
  19. - Browse files with a list view or as thumbnails (images only), with optional
  20. pagination
  21. - List view has image thumbnail on hover
  22. - File display order customisable e.g. by name, type, size, date
  23. - Find function to filter results by search string
  24. - Display detailed file information such as type, size and dimensions (images
  25. only)
  26. - File deletion facility (permission based)
  27. - File edit facility (permission based) - rename, resize and rotate (last two
  28. images only)
  29. - Folder browsing and creation
  30. - File storage location user definable for each file type
  31. - Optional session control
  32. - Multi-lingual support with language definition files
  33. - Many user definable settings, all from central configuration file
  34. TinyBrowser Background
  35. ======================
  36. I created TinyBrowser as I couldn't find the right TinyMCE file browser for my
  37. needs, particularly the ability to select and upload multiple files in an easy
  38. way.
  39. Version Notes
  40. =============
  41. TinyBrowser 1.41 - released 05/05/2009
  42. --------------------------------------
  43. New Features:
  44. Added folder argument to tinyBrowserPopUp function, so that a sub-folder can be
  45. selected when using TinyBrowser in standalone mode.
  46. Added error logging - errors are output to error.log in tinybrowser directory.
  47. Added Spanish, Croatian, Slovakian, Latvian, Czech, Italian, Hungarian, Swedish
  48. and Russian language files (thanks to all who contributed).
  49. Changes:
  50. Prohibited files are no longer browseable (if the paths defined contained files
  51. of this type).
  52. Only defined file extensions of a file type are browseable and editable.
  53. Changed stripos function to strpos to ensure PHP4 compatability.
  54. Updated createfolder function to work recursively with PHP4.
  55. Remember current folder after upload.
  56. Changed filename clean regex to be less strict.
  57. Bug Fixes:
  58. Fixed transparency support for gif and png (thanks to Dirk Bohl).
  59. Added 'no-cache' meta tag to ensure latest page is served by web browser.
  60. Added another fix for no style issue with TinyMCE integration.
  61. Security fix for browse type when set to non-existant value.
  62. Security fix for malicious setting of folder get variable to relative values.
  63. TinyBrowser 1.40 - released N/A
  64. --------------------------------------
  65. New Features:
  66. Added multiple folder support with a separate Folders tab to allow folder
  67. creation, renaming and deletion.
  68. Added Move action to Edit tab, to allow moving of files between folders.
  69. Added Danish language file.
  70. Added 'delayprocess' to config file - this can be set if server response is
  71. delayed, preventing uploaded files being processed correctly.
  72. Added width and height config values for the TinyBrowser pop up window size.
  73. Added 'cleanfilename' flag to config file, to remove disallowed characters
  74. from filenames on upload (set to true by default).
  75. Changes:
  76. Added recursive flag to createfolder function, to allow TinyBrowser to
  77. create full upload path.
  78. Changed default window size to 770px x 480px.
  79. Minor code optimisation.
  80. Prohibited files are now not browseable (if the paths defined contained files of
  81. this type).
  82. Now only defined file extensions of a file type are browseable and editable.
  83. Changed stripos function call to strpos to ensure PHP4 compatability.
  84. Updated createfolder function to work recursively with PHP4.
  85. Remember current folder after upload.
  86. Bug Fixes:
  87. Fixed minor bug causing elementid to be lost after file upload in
  88. stand-alone mode.
  89. Fixed stand-alone javascript selectURL function bug that prevented
  90. TinyBrowser window close on selection.
  91. Fixed bug in Flash upload that prevented folder permission error reporting.
  92. Fixed bug in image resize and rotate functions that converted all types
  93. to jpeg.
  94. TinyBrowser 1.33 - released 23/09/2008
  95. --------------------------------------
  96. New Features:
  97. Added German, Finnish, Traditional and Simplified Chinese language files.
  98. Added session control workaround for upload_file.php (called by Flash).
  99. Changes:
  100. Flash uploader has been modified to display the file type and also to fix
  101. strange progress bar behaviour when uploading multiple files. As the
  102. upload process is not concurrent, I have removed the individual progress
  103. bars and replaced them with one (progress is still per file however).
  104. When the Upload button is pressed all the buttons now disappear.
  105. Bug Fixes:
  106. Fixed minor bug that affected css layout after file upload.
  107. Fixed bug introduced in 1.32 that prevented automatic image resize on
  108. upload.
  109. Added 'HTTP/1.1 200' response to upload_file.php script, to address
  110. Flash bug in some Mac setups.
  111. Added check for valid images in Browse and Edit tabs - non-image files
  112. are still listed but error producing image properties code is bypassed.
  113. TinyBrowser 1.32 - released 17/09/2008
  114. --------------------------------------
  115. New Features:
  116. None.
  117. Changes:
  118. The upload path is now passed to the Flash upload widget, for better
  119. compatibility with Firefox and Opera when you set your paths using session
  120. variables (this is due to a Flash bug that loses session data).
  121. Files are no longer uploaded to a temporary directory, so there's now no
  122. folder creation during the upload process. Instead, file name extensions
  123. are suffixed with an underscore until processed. (This renders them
  124. useless until verification).
  125. The thumbs directory has been changed to '_thumbs'.
  126. Bug Fixes:
  127. Fixed security hole - previously, it was possible to directly
  128. submit files to the upload_file.php script. Due to the Flash session bug,
  129. normal session control does not work. Instead, a hash string check has been
  130. added to the upload_file.php script and the installation instructions
  131. amended.
  132. TinyBrowser 1.31 - released 16/09/2008
  133. --------------------------------------
  134. New Features:
  135. None.
  136. Changes:
  137. Added prohibited files logic to the file_upload.php script (previously
  138. located only in file_process.php script).
  139. Changed duplicate file handling behaviour - TinyBrowser now discards
  140. files with the same name.
  141. Bug Fixes:
  142. None.
  143. TinyBrowser 1.30 - released 12/09/2008
  144. --------------------------------------
  145. New Features:
  146. 'Stand-alone' mode, for use without TinyMCE.
  147. Optional and configurable pagination, to break results down into pages.
  148. New configuration option, $tinybrowser['link'], allows the passback link to
  149. be different to the upload path.
  150. Added automatic creation of upload directories (with definable chmod for Unix
  151. servers).
  152. Added alert messages for errors and actions.
  153. Multi-lingual support - credit to Francis Rebouças
  154. (francisreboucas[at]gmail[dot]com) for idea, design, implementation and
  155. Portugese language file.
  156. Experimental support for FCKeditor.
  157. Changes:
  158. Rationalised TinyBrowser file and folder names and structure (brought in line
  159. with TinyMCE plugin specification).
  160. Revised documentation.
  161. After file upload user is now directed back to upload tab instead of the
  162. browse tab.
  163. Bug Fixes:
  164. Fixed security hole - prohibited file extensions not obeyed due to error in
  165. inherited code.
  166. Fixed small issue with edit / delete permissions (not consistently hiding
  167. edit tab).
  168. TinyBrowser 1.20 - released 20/08/2008
  169. --------------------------------------
  170. New Features:
  171. Added thumbnail on hover for detail view (images only). Note: not working in
  172. IE6.
  173. Added Edit tab - allows file rename, resize and rotate (last two for images
  174. only). Also moved delete action to here.
  175. Added configurable automatic image resize on upload.
  176. Changes:
  177. Moved file thumbnail generation to upload process.
  178. Changed table css to match Flash upload.
  179. Improved thumbnail view layout.
  180. Removed the form select elements for sort by and type, and made the table
  181. column headers clickable.
  182. Bug Fixes:
  183. Changed default $tinymce['docroot'] value to
  184. rtrim($_SERVER['DOCUMENT_ROOT'],'/') - this fixes an issue with server setups
  185. that return a value with a '/' suffix.
  186. Removed .htaccess file after various bug reports - doesn't appear to be
  187. required for majority of server setups.
  188. Fixed silly bug with thumbnail urls that could prevent generation and viewing
  189. under some server setups.
  190. Fixed various other minor bugs and tidied code.
  191. TinyBrowser 1.10
  192. ----------------
  193. Adjusted layout of file upload.
  194. Added facility to limit permitted file upload size (separate values for each
  195. file type).
  196. Amended installation instructions for clarity.
  197. Tested as working in Opera 9.
  198. TinyBrowser 1.00
  199. ----------------
  200. Tested in Firefox 2 and 3, Internet Explorer 6 and 7 and Safari 3.
  201. Requires Adobe Flash Player 9.
  202. Requirements
  203. ============
  204. Adobe Flash Player 8 +
  205. PHP enabled server
  206. Supported browsers:
  207. Internet Explorer 6 +
  208. Firefox 2 +
  209. Safari 3 +
  210. Opera 9 +
  211. Google Chrome
  212. Language Definition Files
  213. =========================
  214. English (en)
  215. Chinese Simplified (zh-cn)
  216. Chinese Traditional (zh-tw)
  217. Croatian (hr)
  218. Czech (cs)
  219. Danish (da)
  220. Dutch (nl)
  221. Finnish (fi)
  222. French (fr)
  223. German (de)
  224. Hungarian (hu)
  225. Italian (it)
  226. Latvian (lv)
  227. Polish (pl)
  228. Portuguese (pt)
  229. Russian (ru)
  230. Slovak (sk)
  231. Spanish (es)
  232. Swedish (sv)
  233. Known Issues
  234. ============
  235. None.
  236. Troubleshooting
  237. ===============
  238. If you receive a 403, 406 or 412 status error on uploading files, please create
  239. an .htaccess file in your tinybrowser directory with the following contents:
  240. SecFilterEngine Off
  241. SecFilterScanPOST Off
  242. If you use Linux and the Squid proxy, you need to add a "ignore_expect_100 on"
  243. flag to the squid config file to avoid a 417 status error.
  244. TinyBrowser Installation Method 1
  245. =================================
  246. The standard TinyBrowser installation, this integrates TinyBrowser as a custom
  247. file browseer with TinyMCE.
  248. 1) Copy the tinybrowser folder and contents to your TinyMCE plugins directory.
  249. 2) Place the following javascript link after the link to TinyMCE (tiny_mce.js):
  250. ***NOTE:*** The above link assumes TinyMCE is installed in your website root
  251. directory, you will need to amend the link to your specific setup!
  252. 3) Add this line to your TinyMCE init:
  253. file_browser_callback : "tinyBrowser"
  254. 4) Edit the TinyBrowser configuration file (config_tinybrowser.php). The most
  255. important settings are the file paths (these will be automatically created on
  256. your server by TinyBrowser if they do not exist) and also the 'obfuscate'
  257. property, which should be set to a random value.
  258. ***NOTE:*** If your server is Unix-based. you may wish to modify the
  259. $tinybrowser['unixpermissions'] config value, which decides permissions.
  260. 5) All done! Now you will see a browse button in the TinyMCE dialog windows for
  261. plugins like image, media and link - just click this button and TinyBrowser
  262. will appear.
  263. TinyBrowser Installation Method 2
  264. =================================
  265. This installation allows TinyBrowser to be used in 'stand-alone' mode, for
  266. integration with any web application.
  267. 1) Copy the tinybrowser folder and contents to your server.
  268. 2) Place the following javascript link within the tag on the page you
  269. require TinyBrowser:
  270. ***NOTE:*** The above link assumes TinyBrowser is installed in your website
  271. root directory, you will need to amend the link to your specific setup!
  272. 3) Edit the TinyBrowser configuration file (config_tinybrowser.php). The most
  273. important settings are the file paths (these will be automatically created on
  274. your server by TinyBrowser if they do not exist) and also the 'obfuscate'
  275. property, which should be set to a random value.
  276. ***NOTE:*** If your server is Unix-based. you may wish to modify the
  277. $tinybrowser['unixpermissions'] config value, which decides permissions.
  278. 4) To launch TinyBrowser use the following javascript function:
  279. tinyBrowserPopUp('type','elementid');
  280. 'type' can contain 'image', 'media' or 'file' - corresponding to the type of
  281. file you want TinyBrowser to manage.
  282. 'elementid' is the id of the page element you want populate with the file url
  283. TinyBrowser returns - this is generally a form text input. If you want to
  284. immediately display the image then create an tag with the same element
  285. id, only suffixed with img - e.g. elementidimg.
  286. TinyBrowser Installation Method 3
  287. =================================
  288. This installation method integrates TinyBrowser as a custom file browser with
  289. FCKeditor.
  290. 1) Copy the tinybrowser folder and contents to your server.
  291. 2) Edit your fckconfig.js file as follows (replace existing lines).
  292. To enable TinyBrowser for files:
  293. FCKConfig.LinkBrowserURL = '/yourtinybrowserurl/tinybrowser.php?type=file';
  294. To enable TinyBrowser for images:
  295. FCKConfig.ImageBrowserURL = '/yourtinybrowserurl/tinybrowser.php?type=image';
  296. To enable TinyBrowser for Flash:
  297. FCKConfig.FlashBrowserURL = '/yourtinybrowserurl/tinybrowser.php?type=media';
  298. If you wish to disable the default FCKeditor file uploads (recommended), set
  299. the following:
  300. FCKConfig.LinkUpload = false;
  301. FCKConfig.ImageUpload = false;
  302. FCKConfig.FlashUpload = false;
  303. 3) Edit the TinyBrowser configuration file (config_tinybrowser.php).
  304. Change the $tinybrowser['integration'] line:
  305. $tinybrowser['integration'] = 'fckeditor';
  306. The other most important settings are the file paths (these will be
  307. automatically created on your server by TinyBrowser if they do not exist) and
  308. the 'obfuscate' property, which should be set to a random value.
  309. ***NOTE:*** If your server is Unix-based. you may wish to modify the
  310. $tinybrowser['unixpermissions'] config value, which decides permissions.
  311. 4) All done! Now when you click the Browse Server button in the FCKeditor dialog
  312. windows for image, Flash and link, TinyBrowser will appear instead of the
  313. standard FCKeditor file browser.
  314. Contact
  315. =======
  316. Please notify me by email bryn[at]lunarvis[dot]com if you notice any bugs or
  317. have ideas for new features.
  318. -----------------------------
  319. File Last Modified 05/05/2009