ckeditor/_source/core/ckeditor_base.js

   1 /*
   2 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
   3 For licensing, see LICENSE.html or http://ckeditor.com/license
   4 */
   5
   6 /**
   7  * @fileOverview Contains the first and essential part of the {@link CKEDITOR}
   8  *              object definition.
   9  */
  10
  11 // #### Compressed Code
  12 // Must be updated on changes in the script, as well as updated in the
  13 // ckeditor_source.js and ckeditor_basic_source.js files.
  14
  15 // if(!window.CKEDITOR)window.CKEDITOR=(function(){var a={timestamp:'',version:'3.2.1',rev:'5372',_:{},status:'unloaded',basePath:(function(){var d=window.CKEDITOR_BASEPATH||'';if(!d){var e=document.getElementsByTagName('script');for(var f=0;f<e.length;f++){var g=e[f].src.match(/(^|.*[\\\/])ckeditor(?:_basic)?(?:_source)?.js(?:\?.*)?$/i);if(g){d=g[1];break;}}}if(d.indexOf('://')==-1)if(d.indexOf('/')===0)d=location.href.match(/^.*?:\/\/[^\/]*/)[0]+d;else d=location.href.match(/^[^\?]*\/(?:)/)[0]+d;return d;})(),getUrl:function(d){if(d.indexOf('://')==-1&&d.indexOf('/')!==0)d=this.basePath+d;if(this.timestamp&&d.charAt(d.length-1)!='/')d+=(d.indexOf('?')>=0?'&':'?')+('t=')+this.timestamp;return d;}},b=window.CKEDITOR_GETURL;if(b){var c=a.getUrl;a.getUrl=function(d){return b.call(a,d)||c.call(a,d);};}return a;})();
  16
  17 // #### Raw code
  18 // ATTENTION: read the above "Compressed Code" notes when changing this code.
  19
  20 if ( !window.CKEDITOR )
  21 {
  22         /**
  23          * This is the API entry point. The entire CKEditor code runs under this object.
  24          * @name CKEDITOR
  25          * @namespace
  26          * @example
  27          */
  28         window.CKEDITOR = (function()
  29         {
  30                 var CKEDITOR =
  31                 /** @lends CKEDITOR */
  32                 {
  33
  34                         /**
  35                          * A constant string unique for each release of CKEditor. Its value
  36                          * is used, by default, to build the URL for all resources loaded
  37                          * by the editor code, guaranteing clean cache results when
  38                          * upgrading.
  39                          * @type String
  40                          * @example
  41                          * alert( CKEDITOR.timestamp );  // e.g. '87dm'
  42                          */
  43                         // The production implementation contains a fixed timestamp, unique
  44                         // for each release, generated by the releaser.
  45                         // (Base 36 value of each component of YYMMDDHH - 4 chars total - e.g. 87bm == 08071122)
  46                         timestamp : 'A39E',
  47
  48                         /**
  49                          * Contains the CKEditor version number.
  50                          * @type String
  51                          * @example
  52                          * alert( CKEDITOR.version );  // e.g. 'CKEditor 3.0 Beta'
  53                          */
  54                         version : '3.2.1',
  55
  56                         /**
  57                          * Contains the CKEditor revision number.
  58                          * Revision number is incremented automatically after each modification of CKEditor source code.
  59                          * @type String
  60                          * @example
  61                          * alert( CKEDITOR.revision );  // e.g. '3975'
  62                          */
  63                         revision : '5372',
  64
  65                         /**
  66                          * Private object used to hold core stuff. It should not be used out of
  67                          * the API code as properties defined here may change at any time
  68                          * without notice.
  69                          * @private
  70                          */
  71                         _ : {},
  72
  73                         /**
  74                          * Indicates the API loading status. The following status are available:
  75                          *              <ul>
  76                          *                      <li><b>unloaded</b>: the API is not yet loaded.</li>
  77                          *                      <li><b>basic_loaded</b>: the basic API features are available.</li>
  78                          *                      <li><b>basic_ready</b>: the basic API is ready to load the full core code.</li>
  79                          *                      <li><b>loading</b>: the full API is being loaded.</li>
  80                          *                      <li><b>ready</b>: the API can be fully used.</li>
  81                          *              </ul>
  82                          * @type String
  83                          * @example
  84                          * if ( <b>CKEDITOR.status</b> == 'ready' )
  85                          * {
  86                          *     // The API can now be fully used.
  87                          * }
  88                          */
  89                         status : 'unloaded',
  90
  91                         /**
  92                          * Contains the full URL for the CKEditor installation directory.
  93                          * It's possible to manually provide the base path by setting a
  94                          * global variable named CKEDITOR_BASEPATH. This global variable
  95                          * must be set "before" the editor script loading.
  96                          * @type String
  97                          * @example
  98                          * alert( <b>CKEDITOR.basePath</b> );  // "http://www.example.com/ckeditor/" (e.g.)
  99                          */
 100                         basePath : (function()
 101                         {
 102                                 // ATTENTION: fixes on this code must be ported to
 103                                 // var basePath in "core/loader.js".
 104
 105                                 // Find out the editor directory path, based on its <script> tag.
 106                                 var path = window.CKEDITOR_BASEPATH || '';
 107
 108                                 if ( !path )
 109                                 {
 110                                         var scripts = document.getElementsByTagName( 'script' );
 111
 112                                         for ( var i = 0 ; i < scripts.length ; i++ )
 113                                         {
 114                                                 var match = scripts[i].src.match( /(^|.*[\\\/])ckeditor(?:_basic)?(?:_source)?.js(?:\?.*)?$/i );
 115
 116                                                 if ( match )
 117                                                 {
 118                                                         path = match[1];
 119                                                         break;
 120                                                 }
 121                                         }
 122                                 }
 123
 124                                 // In IE (only) the script.src string is the raw valued entered in the
 125                                 // HTML. Other browsers return the full resolved URL instead.
 126                                 if ( path.indexOf('://') == -1 )
 127                                 {
 128                                         // Absolute path.
 129                                         if ( path.indexOf( '/' ) === 0 )
 130                                                 path = location.href.match( /^.*?:\/\/[^\/]*/ )[0] + path;
 131                                         // Relative path.
 132                                         else
 133                                                 path = location.href.match( /^[^\?]*\/(?:)/ )[0] + path;
 134                                 }
 135
 136                                 if ( !path )
 137                                                 throw 'The CKEditor installation path could not be automatically detected. Please set the global variable "CKEDITOR_BASEPATH" before creating editor instances.';
 138
 139                                 return path;
 140                         })(),
 141
 142                         /**
 143                          * Gets the full URL for CKEditor resources. By default, URLs
 144                          * returned by this function contains a querystring parameter ("t")
 145                          * set to the {@link CKEDITOR.timestamp} value.
 146                          * It's possible to provide a custom implementation to this
 147                          * function by setting a global variable named CKEDITOR_GETURL.
 148                          * This global variable must be set "before" the editor script
 149                          * loading. If the custom implementation returns nothing, the
 150                          * default implementation is used.
 151                          * @returns {String} The full URL.
 152                          * @example
 153                          * // e.g. http://www.example.com/ckeditor/skins/default/editor.css?t=87dm
 154                          * alert( CKEDITOR.getUrl( 'skins/default/editor.css' ) );
 155                          * @example
 156                          * // e.g. http://www.example.com/skins/default/editor.css?t=87dm
 157                          * alert( CKEDITOR.getUrl( '/skins/default/editor.css' ) );
 158                          * @example
 159                          * // e.g. http://www.somesite.com/skins/default/editor.css?t=87dm
 160                          * alert( CKEDITOR.getUrl( 'http://www.somesite.com/skins/default/editor.css' ) );
 161                          */
 162                         getUrl : function( resource )
 163                         {
 164                                 // If this is not a full or absolute path.
 165                                 if ( resource.indexOf('://') == -1 && resource.indexOf( '/' ) !== 0 )
 166                                         resource = this.basePath + resource;
 167
 168                                 // Add the timestamp, except for directories.
 169                                 if ( this.timestamp && resource.charAt( resource.length - 1 ) != '/' )
 170                                         resource += ( resource.indexOf( '?' ) >= 0 ? '&' : '?' ) + 't=' + this.timestamp;
 171
 172                                 return resource;
 173                         }
 174                 };
 175
 176                 // Make it possible to override the getUrl function with a custom
 177                 // implementation pointing to a global named CKEDITOR_GETURL.
 178                 var newGetUrl = window.CKEDITOR_GETURL;
 179                 if ( newGetUrl )
 180                 {
 181                         var originalGetUrl = CKEDITOR.getUrl;
 182                         CKEDITOR.getUrl = function ( resource )
 183                         {
 184                                 return newGetUrl.call( CKEDITOR, resource ) ||
 185                                         originalGetUrl.call( CKEDITOR, resource );
 186                         };
 187                 }
 188
 189                 return CKEDITOR;
 190         })();
 191 }
 192
 193 // PACKAGER_RENAME( CKEDITOR )