[Summary view] [Print] [Text view]

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