active_scaffold 3.3.3 → 3.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (198) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG +39 -0
  3. data/README.md +5 -3
  4. data/app/assets/images/active_scaffold/refresh.png +0 -0
  5. data/app/assets/javascripts/jquery/active_scaffold.js +182 -91
  6. data/app/assets/javascripts/jquery/date_picker_bridge.js.erb +14 -16
  7. data/app/assets/javascripts/jquery/draggable_lists.js +33 -26
  8. data/app/assets/javascripts/jquery/jquery.editinplace.js +3 -3
  9. data/app/assets/javascripts/prototype/active_scaffold.js +61 -19
  10. data/app/assets/stylesheets/active_scaffold_colors.css.scss +4 -0
  11. data/app/assets/stylesheets/active_scaffold_images.css.scss +3 -0
  12. data/app/assets/stylesheets/active_scaffold_layout.css +23 -2
  13. data/app/views/active_scaffold_overrides/_add_existing_form.html.erb +1 -3
  14. data/app/views/active_scaffold_overrides/_base_form.html.erb +7 -5
  15. data/app/views/active_scaffold_overrides/_field_search.html.erb +1 -2
  16. data/app/views/active_scaffold_overrides/_form.html.erb +6 -4
  17. data/app/views/active_scaffold_overrides/_form_association.html.erb +4 -3
  18. data/app/views/active_scaffold_overrides/_form_association_footer.html.erb +5 -5
  19. data/app/views/active_scaffold_overrides/_form_association_record.html.erb +8 -6
  20. data/app/views/active_scaffold_overrides/_horizontal_subform_header.html.erb +3 -2
  21. data/app/views/active_scaffold_overrides/_list.html.erb +8 -6
  22. data/app/views/active_scaffold_overrides/_list_column_headings.html.erb +1 -4
  23. data/app/views/active_scaffold_overrides/_list_pagination.html.erb +4 -4
  24. data/app/views/active_scaffold_overrides/_list_pagination_links.html.erb +1 -1
  25. data/app/views/active_scaffold_overrides/_list_record.html.erb +3 -3
  26. data/app/views/active_scaffold_overrides/_refresh_list.js.erb +8 -1
  27. data/app/views/active_scaffold_overrides/_search.html.erb +7 -13
  28. data/app/views/active_scaffold_overrides/_show_columns.html.erb +1 -1
  29. data/app/views/active_scaffold_overrides/on_create.js.erb +4 -4
  30. data/app/views/active_scaffold_overrides/render_field_inplace.html.erb +1 -1
  31. data/app/views/active_scaffold_overrides/row.js.erb +1 -1
  32. data/config/locales/de.yml +106 -95
  33. data/config/locales/en.yml +108 -97
  34. data/config/locales/es.yml +109 -98
  35. data/config/locales/fr.yml +108 -97
  36. data/config/locales/hu.yml +109 -98
  37. data/config/locales/ja.yml +100 -89
  38. data/config/locales/ru.yml +115 -104
  39. data/lib/active_scaffold.rb +18 -294
  40. data/lib/active_scaffold/actions/common_search.rb +50 -17
  41. data/lib/active_scaffold/actions/core.rb +93 -22
  42. data/lib/active_scaffold/actions/create.rb +15 -6
  43. data/lib/active_scaffold/actions/field_search.rb +68 -60
  44. data/lib/active_scaffold/actions/list.rb +49 -28
  45. data/lib/active_scaffold/actions/nested.rb +14 -6
  46. data/lib/active_scaffold/actions/search.rb +36 -35
  47. data/lib/active_scaffold/actions/show.rb +9 -4
  48. data/lib/active_scaffold/actions/subform.rb +1 -1
  49. data/lib/active_scaffold/actions/update.rb +22 -7
  50. data/lib/active_scaffold/active_record_permissions.rb +125 -118
  51. data/lib/active_scaffold/attribute_params.rb +84 -66
  52. data/lib/active_scaffold/bridges.rb +3 -3
  53. data/lib/active_scaffold/bridges/ancestry/ancestry_bridge.rb +10 -5
  54. data/lib/active_scaffold/bridges/cancan.rb +2 -1
  55. data/lib/active_scaffold/bridges/cancan/cancan_bridge.rb +13 -2
  56. data/lib/active_scaffold/bridges/carrierwave/form_ui.rb +11 -6
  57. data/lib/active_scaffold/bridges/chosen/helpers.rb +2 -2
  58. data/lib/active_scaffold/bridges/country_helper/country_helper_bridge.rb +45 -29
  59. data/lib/active_scaffold/bridges/date_picker/ext.rb +11 -6
  60. data/lib/active_scaffold/bridges/date_picker/helper.rb +5 -1
  61. data/lib/active_scaffold/bridges/dragonfly/form_ui.rb +10 -5
  62. data/lib/active_scaffold/bridges/dragonfly/list_ui.rb +6 -1
  63. data/lib/active_scaffold/bridges/file_column/form_ui.rb +12 -11
  64. data/lib/active_scaffold/bridges/paperclip/form_ui.rb +14 -6
  65. data/lib/active_scaffold/bridges/paperclip/list_ui.rb +1 -1
  66. data/lib/active_scaffold/bridges/record_select/helpers.rb +15 -12
  67. data/lib/active_scaffold/bridges/shared/date_bridge.rb +7 -8
  68. data/lib/active_scaffold/bridges/tiny_mce.rb +5 -3
  69. data/lib/active_scaffold/bridges/tiny_mce/helpers.rb +4 -5
  70. data/lib/active_scaffold/config/base.rb +4 -0
  71. data/lib/active_scaffold/config/core.rb +12 -5
  72. data/lib/active_scaffold/config/delete.rb +0 -2
  73. data/lib/active_scaffold/config/field_search.rb +1 -4
  74. data/lib/active_scaffold/config/form.rb +0 -2
  75. data/lib/active_scaffold/config/list.rb +31 -1
  76. data/lib/active_scaffold/config/search.rb +0 -3
  77. data/lib/active_scaffold/config/show.rb +0 -6
  78. data/lib/active_scaffold/config/subform.rb +1 -0
  79. data/lib/active_scaffold/configurable.rb +2 -2
  80. data/lib/active_scaffold/constraints.rb +11 -14
  81. data/lib/active_scaffold/core.rb +277 -0
  82. data/lib/active_scaffold/data_structures/action_columns.rb +18 -2
  83. data/lib/active_scaffold/data_structures/action_link.rb +25 -6
  84. data/lib/active_scaffold/data_structures/action_links.rb +9 -4
  85. data/lib/active_scaffold/data_structures/actions.rb +1 -1
  86. data/lib/active_scaffold/data_structures/column.rb +6 -6
  87. data/lib/active_scaffold/data_structures/columns.rb +2 -2
  88. data/lib/active_scaffold/data_structures/nested_info.rb +5 -1
  89. data/lib/active_scaffold/data_structures/sorting.rb +15 -5
  90. data/lib/active_scaffold/delayed_setup.rb +30 -0
  91. data/lib/active_scaffold/engine.rb +25 -0
  92. data/lib/active_scaffold/extensions/action_view_rendering.rb +1 -1
  93. data/lib/active_scaffold/extensions/left_outer_joins.rb +61 -21
  94. data/lib/active_scaffold/extensions/localize.rb +1 -1
  95. data/lib/active_scaffold/extensions/name_option_for_datetime.rb +13 -8
  96. data/lib/active_scaffold/extensions/paginator_extensions.rb +5 -1
  97. data/lib/active_scaffold/extensions/reverse_associations.rb +1 -0
  98. data/lib/active_scaffold/extensions/routing_mapper.rb +1 -1
  99. data/lib/active_scaffold/extensions/unsaved_record.rb +4 -6
  100. data/lib/active_scaffold/finder.rb +79 -27
  101. data/lib/active_scaffold/helpers/association_helpers.rb +48 -18
  102. data/lib/active_scaffold/helpers/controller_helpers.rb +19 -10
  103. data/lib/active_scaffold/helpers/form_column_helpers.rb +185 -87
  104. data/lib/active_scaffold/helpers/human_condition_helpers.rb +2 -1
  105. data/lib/active_scaffold/helpers/id_helpers.rb +14 -8
  106. data/lib/active_scaffold/helpers/list_column_helpers.rb +65 -56
  107. data/lib/active_scaffold/helpers/pagination_helpers.rb +5 -1
  108. data/lib/active_scaffold/helpers/search_column_helpers.rb +21 -18
  109. data/lib/active_scaffold/helpers/view_helpers.rb +102 -64
  110. data/lib/active_scaffold/responds_to_parent.rb +39 -64
  111. data/lib/active_scaffold/tableless.rb +129 -10
  112. data/lib/active_scaffold/version.rb +2 -2
  113. data/test/bridges/bridge_test.rb +1 -1
  114. data/test/bridges/date_picker_test.rb +2 -2
  115. data/test/bridges/paperclip_test.rb +10 -8
  116. data/test/bridges/tiny_mce_test.rb +2 -2
  117. data/test/company.rb +22 -10
  118. data/test/config/base_test.rb +1 -1
  119. data/test/config/core_test.rb +8 -6
  120. data/test/config/create_test.rb +6 -6
  121. data/test/config/delete_test.rb +4 -4
  122. data/test/config/field_search_test.rb +6 -6
  123. data/test/config/list_test.rb +7 -7
  124. data/test/config/nested_test.rb +8 -7
  125. data/test/config/search_test.rb +7 -7
  126. data/test/config/show_test.rb +5 -5
  127. data/test/config/subform_test.rb +1 -1
  128. data/test/config/update_test.rb +5 -4
  129. data/test/data_structures/action_columns_test.rb +15 -16
  130. data/test/data_structures/action_link_test.rb +10 -10
  131. data/test/data_structures/action_links_test.rb +6 -6
  132. data/test/data_structures/actions_test.rb +4 -4
  133. data/test/data_structures/association_column_test.rb +4 -4
  134. data/test/data_structures/column_test.rb +9 -9
  135. data/test/data_structures/columns_test.rb +7 -7
  136. data/test/data_structures/error_message_test.rb +2 -4
  137. data/test/data_structures/set_test.rb +13 -13
  138. data/test/data_structures/sorting_test.rb +8 -8
  139. data/test/data_structures/standard_column_test.rb +2 -2
  140. data/test/data_structures/validation_reflection_test.rb +8 -8
  141. data/test/data_structures/virtual_column_test.rb +5 -5
  142. data/test/extensions/active_record_test.rb +1 -1
  143. data/test/helpers/form_column_helpers_test.rb +5 -5
  144. data/test/helpers/list_column_helpers_test.rb +2 -1
  145. data/test/helpers/pagination_helpers_test.rb +1 -1
  146. data/test/misc/active_record_permissions_test.rb +23 -4
  147. data/test/misc/attribute_params_test.rb +304 -136
  148. data/test/misc/calculation_test.rb +55 -0
  149. data/test/misc/configurable_test.rb +22 -21
  150. data/test/misc/constraints_test.rb +10 -7
  151. data/test/misc/convert_numbers_format_test.rb +149 -0
  152. data/test/misc/finder_test.rb +17 -13
  153. data/test/misc/lang_test.rb +1 -1
  154. data/test/misc/tableless_test.rb +18 -0
  155. data/test/mock_app/app/controllers/addresses_controller.rb +4 -0
  156. data/test/mock_app/app/controllers/buildings_controller.rb +4 -0
  157. data/test/mock_app/app/controllers/cars_controller.rb +4 -0
  158. data/test/mock_app/app/controllers/contacts_controller.rb +4 -0
  159. data/test/mock_app/app/controllers/floors_controller.rb +6 -0
  160. data/test/mock_app/app/controllers/people_controller.rb +4 -0
  161. data/test/mock_app/app/models/address.rb +3 -0
  162. data/test/mock_app/app/models/building.rb +8 -0
  163. data/test/mock_app/app/models/car.rb +3 -0
  164. data/test/mock_app/app/models/contact.rb +3 -0
  165. data/test/mock_app/app/models/file_model.rb +19 -0
  166. data/test/mock_app/app/models/floor.rb +8 -0
  167. data/test/mock_app/app/models/person.rb +11 -0
  168. data/test/mock_app/config/application.rb +2 -0
  169. data/test/mock_app/config/environments/test.rb +1 -1
  170. data/test/mock_app/config/initializers/secret_token.rb +5 -1
  171. data/test/mock_app/config/routes.rb +1 -1
  172. data/test/mock_app/db/schema.rb +51 -0
  173. data/test/model_stub.rb +3 -3
  174. data/test/test_helper.rb +15 -12
  175. metadata +51 -50
  176. data/lib/active_scaffold/extensions/array.rb +0 -7
  177. data/lib/active_scaffold/extensions/cache_association.rb +0 -16
  178. data/lib/active_scaffold/extensions/usa_state.rb +0 -46
  179. data/lib/active_scaffold_env.rb +0 -13
  180. data/test/extensions/array_test.rb +0 -12
  181. data/test/mock_app/public/blank.html +0 -33
  182. data/test/mock_app/public/images/active_scaffold/DO_NOT_EDIT +0 -2
  183. data/test/mock_app/public/images/active_scaffold/default/add.gif +0 -0
  184. data/test/mock_app/public/images/active_scaffold/default/arrow_down.gif +0 -0
  185. data/test/mock_app/public/images/active_scaffold/default/arrow_up.gif +0 -0
  186. data/test/mock_app/public/images/active_scaffold/default/close.gif +0 -0
  187. data/test/mock_app/public/images/active_scaffold/default/cross.png +0 -0
  188. data/test/mock_app/public/images/active_scaffold/default/indicator-small.gif +0 -0
  189. data/test/mock_app/public/images/active_scaffold/default/indicator.gif +0 -0
  190. data/test/mock_app/public/images/active_scaffold/default/magnifier.png +0 -0
  191. data/test/mock_app/public/javascripts/active_scaffold/DO_NOT_EDIT +0 -2
  192. data/test/mock_app/public/javascripts/active_scaffold/default/active_scaffold.js +0 -532
  193. data/test/mock_app/public/javascripts/active_scaffold/default/dhtml_history.js +0 -867
  194. data/test/mock_app/public/javascripts/active_scaffold/default/form_enhancements.js +0 -117
  195. data/test/mock_app/public/javascripts/active_scaffold/default/rico_corner.js +0 -370
  196. data/test/mock_app/public/stylesheets/active_scaffold/DO_NOT_EDIT +0 -2
  197. data/test/mock_app/public/stylesheets/active_scaffold/default/stylesheet-ie.css +0 -35
  198. data/test/mock_app/public/stylesheets/active_scaffold/default/stylesheet.css +0 -848
@@ -1,867 +0,0 @@
1
- /*
2
- Copyright (c) 2007 Brian Dillard and Brad Neuberg:
3
- Brian Dillard | Project Lead | bdillard@pathf.com | http://blogs.pathf.com/agileajax/
4
- Brad Neuberg | Original Project Creator | http://codinginparadise.org
5
-
6
- SVN r113 from http://code.google.com/p/reallysimplehistory
7
- + Changes by Ed Wildgoose - MailASail
8
- + Changed EncodeURIComponent -> EncodeURI
9
- + Changed DecodeURIComponent -> DecodeURI
10
- + Changed 'blank.html?' -> '/blank.html?'
11
-
12
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
13
- (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge,
14
- publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do
15
- so, subject to the following conditions:
16
-
17
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
18
-
19
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
21
- FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
- */
24
-
25
- /*
26
- dhtmlHistory: An object that provides history, history data, and bookmarking for DHTML and Ajax applications.
27
-
28
- dependencies:
29
- * the historyStorage object included in this file.
30
-
31
- */
32
- window.dhtmlHistory = {
33
-
34
- /*Public: User-agent booleans*/
35
- isIE: false,
36
- isOpera: false,
37
- isSafari: false,
38
- isKonquerer: false,
39
- isGecko: false,
40
- isSupported: false,
41
-
42
- /*Public: Create the DHTML history infrastructure*/
43
- create: function(options) {
44
-
45
- /*
46
- options - object to store initialization parameters
47
- options.blankURL - string to override the default location of blank.html. Must end in "?"
48
- options.debugMode - boolean that causes hidden form fields to be shown for development purposes.
49
- options.toJSON - function to override default JSON stringifier
50
- options.fromJSON - function to override default JSON parser
51
- options.baseTitle - pattern for title changes; example: "Armchair DJ [@@@]" - @@@ will be replaced
52
- */
53
-
54
- var that = this;
55
-
56
- /*Set up the historyStorage object; pass in options bundle*/
57
- window.historyStorage.setup(options);
58
-
59
- /*Set up our base title if one is passed in*/
60
- if (options && options.baseTitle) {
61
- if (options.baseTitle.indexOf("@@@") < 0 && historyStorage.debugMode) {
62
- throw new Error("Programmer error: options.baseTitle must contain the replacement parameter"
63
- + " '@@@' to be useful.");
64
- }
65
- this.baseTitle = options.baseTitle;
66
- }
67
-
68
- /*set user-agent flags*/
69
- var UA = navigator.userAgent.toLowerCase();
70
- var platform = navigator.platform.toLowerCase();
71
- var vendor = navigator.vendor || "";
72
- if (vendor === "KDE") {
73
- this.isKonqueror = true;
74
- this.isSupported = false;
75
- } else if (typeof window.opera !== "undefined") {
76
- this.isOpera = true;
77
- this.isSupported = true;
78
- } else if (typeof document.all !== "undefined") {
79
- this.isIE = true;
80
- this.isSupported = true;
81
- } else if (vendor.indexOf("Apple Computer, Inc.") > -1) {
82
- this.isSafari = true;
83
- this.isSupported = (platform.indexOf("mac") > -1);
84
- } else if (UA.indexOf("gecko") != -1) {
85
- this.isGecko = true;
86
- this.isSupported = true;
87
- }
88
-
89
- /*Create Safari/Opera-specific code*/
90
- if (this.isSafari) {
91
- this.createSafari();
92
- } else if (this.isOpera) {
93
- this.createOpera();
94
- }
95
-
96
- /*Get our initial location*/
97
- var initialHash = this.getCurrentLocation();
98
-
99
- /*Save it as our current location*/
100
- this.currentLocation = initialHash;
101
-
102
- /*Now that we have a hash, create IE-specific code*/
103
- if (this.isIE) {
104
- /*Optionally override the URL of IE's blank HTML file*/
105
- if (options && options.blankURL) {
106
- var u = options.blankURL;
107
- /*assign the value, adding the trailing ? if it's not passed in*/
108
- this.blankURL = (u.indexOf("?") != u.length - 1
109
- ? u + "?"
110
- : u
111
- );
112
- }
113
- this.createIE(initialHash);
114
- }
115
-
116
- /*Add an unload listener for the page; this is needed for FF 1.5+ because this browser caches all dynamic updates to the
117
- page, which can break some of our logic related to testing whether this is the first instance a page has loaded or whether
118
- it is being pulled from the cache*/
119
-
120
- var unloadHandler = function() {
121
- that.firstLoad = null;
122
- };
123
-
124
- this.addEventListener(window,'unload',unloadHandler);
125
-
126
- /*Determine if this is our first page load; for IE, we do this in this.iframeLoaded(), which is fired on pageload. We do it
127
- there because we have no historyStorage at this point, which only exists after the page is finished loading in IE*/
128
- if (this.isIE) {
129
- /*The iframe will get loaded on page load, and we want to ignore this fact*/
130
- this.ignoreLocationChange = true;
131
- } else {
132
- if (!historyStorage.hasKey(this.PAGELOADEDSTRING)) {
133
- /*This is our first page load, so ignore the location change and add our special history entry*/
134
- this.ignoreLocationChange = true;
135
- this.firstLoad = true;
136
- historyStorage.put(this.PAGELOADEDSTRING, true);
137
- } else {
138
- /*This isn't our first page load, so indicate that we want to pay attention to this location change*/
139
- this.ignoreLocationChange = false;
140
- this.firstLoad = false;
141
- /*For browsers other than IE, fire a history change event; on IE, the event will be thrown automatically when its
142
- hidden iframe reloads on page load. Unfortunately, we don't have any listeners yet; indicate that we want to fire
143
- an event when a listener is added.*/
144
- this.fireOnNewListener = true;
145
- }
146
- }
147
-
148
- /*Other browsers can use a location handler that checks at regular intervals as their primary mechanism; we use it for IE as
149
- well to handle an important edge case; see checkLocation() for details*/
150
- var locationHandler = function() {
151
- that.checkLocation();
152
- };
153
- setInterval(locationHandler, 100);
154
- },
155
-
156
- /*Public: Initialize our DHTML history. You must call this after the page is finished loading. Optionally, you can pass your listener in
157
- here so you don't need to make a separate call to addListener*/
158
- initialize: function(listener) {
159
-
160
- /*save original document title to plug in when we hit a null-key history point*/
161
- this.originalTitle = document.title;
162
-
163
- /*IE needs to be explicitly initialized. IE doesn't autofill form data until the page is finished loading, so we have to wait*/
164
- if (this.isIE) {
165
- /*If this is the first time this page has loaded*/
166
- if (!historyStorage.hasKey(this.PAGELOADEDSTRING)) {
167
- /*For IE, we do this in initialize(); for other browsers, we do it in create()*/
168
- this.fireOnNewListener = false;
169
- this.firstLoad = true;
170
- historyStorage.put(this.PAGELOADEDSTRING, true);
171
- }
172
- /*Else if this is a fake onload event*/
173
- else {
174
- this.fireOnNewListener = true;
175
- this.firstLoad = false;
176
- }
177
- }
178
- /*optional convenience to save a separate call to addListener*/
179
- if (listener) {
180
- this.addListener(listener);
181
- }
182
- },
183
-
184
- /*Public: Adds a history change listener. Only one listener is supported at this time.*/
185
- addListener: function(listener) {
186
- this.listener = listener;
187
- /*If the page was just loaded and we should not ignore it, fire an event to our new listener now*/
188
- if (this.fireOnNewListener) {
189
- this.fireHistoryEvent(this.currentLocation);
190
- this.fireOnNewListener = false;
191
- }
192
- },
193
-
194
- /*Public: Change the current HTML title*/
195
- changeTitle: function(historyData) {
196
- var winTitle = (historyData && historyData.newTitle
197
- /*Plug the new title into the pattern*/
198
- ? this.baseTitle.replace('@@@', historyData.newTitle)
199
- /*Otherwise, if there is no new title, use the original document title. This is useful when some
200
- history changes have title changes and some don't; we can automatically return to the original
201
- title rather than leaving a misleading title in the title bar. The same goes for our "virgin"
202
- (hashless) page state.*/
203
- : this.originalTitle
204
- );
205
- /*No need to do anything if the title isn't changing*/
206
- if (document.title == winTitle) {
207
- return;
208
- }
209
-
210
-
211
- /*Now change the DOM*/
212
- document.title = winTitle;
213
- /*Change it in the iframe, too, for IE*/
214
- if (this.isIE) {
215
- this.iframe.contentWindow.document.title = winTitle;
216
- }
217
-
218
- /*If non-IE, reload the hash so the new title "sticks" in the browser history object*/
219
- if (!this.isIE && !this.isOpera) {
220
- var hash = decodeURI(document.location.hash);
221
- if (hash != "") {
222
- var encodedHash = encodeURI(this.removeHash(hash));
223
- document.location.hash = encodedHash;
224
- } else {
225
- //document.location.hash = "#";
226
- }
227
- }
228
- },
229
-
230
- /*Public: Add a history point. Parameters available:
231
- * newLocation (required):
232
- This will be the #hash value in the URL. Users can bookmark it. It will persist across sessions, so
233
- your application should be able to restore itself to a specific state based on just this value. It
234
- should be either a simple keyword for a viewstate or else a pseudo-querystring.
235
- * historyData (optional):
236
- This is for complex data that is relevant only to the current browsing session. It will be available
237
- to your application until the browser is closed. If the user comes back to a bookmarked history point
238
- during a later session, this data will no longer be available. Don't rely on it for application
239
- re-initialization from a bookmark.
240
- * historyData.newTitle (optional):
241
- This will swap out the html <title> attribute with a new value. If you have set a baseTitle using the
242
- options bundle, the value will be plugged into the baseTitle by swapping out the @@@ replacement param.
243
- */
244
- add: function(newLocation, historyData) {
245
-
246
- var that = this;
247
-
248
- /*Escape the location and remove any leading hash symbols*/
249
- var encodedLocation = encodeURI(this.removeHash(newLocation));
250
-
251
- if (this.isSafari) {
252
-
253
- /*Store the history data into history storage - pass in unencoded newLocation since
254
- historyStorage does its own encoding*/
255
- historyStorage.put(newLocation, historyData);
256
-
257
- /*Save this as our current location*/
258
- this.currentLocation = encodedLocation;
259
-
260
- /*Change the browser location*/
261
- window.location.hash = encodedLocation;
262
-
263
- /*Save this to the Safari form field*/
264
- this.putSafariState(encodedLocation);
265
-
266
- this.changeTitle(historyData);
267
-
268
- } else {
269
-
270
- /*Most browsers require that we wait a certain amount of time before changing the location, such
271
- as 200 MS; rather than forcing external callers to use window.setTimeout to account for this,
272
- we internally handle it by putting requests in a queue.*/
273
- var addImpl = function() {
274
-
275
- /*Indicate that the current wait time is now less*/
276
- if (that.currentWaitTime > 0) {
277
- that.currentWaitTime = that.currentWaitTime - that.waitTime;
278
- }
279
-
280
- /*IE has a strange bug; if the encodedLocation is the same as _any_ preexisting id in the
281
- document, then the history action gets recorded twice; throw a programmer exception if
282
- there is an element with this ID*/
283
- if (document.getElementById(encodedLocation) && that.debugMode) {
284
- var e = "Exception: History locations can not have the same value as _any_ IDs that might be in the document,"
285
- + " due to a bug in IE; please ask the developer to choose a history location that does not match any HTML"
286
- + " IDs in this document. The following ID is already taken and cannot be a location: " + newLocation;
287
- throw new Error(e);
288
- }
289
-
290
- /*Store the history data into history storage - pass in unencoded newLocation since
291
- historyStorage does its own encoding*/
292
- historyStorage.put(newLocation, historyData);
293
-
294
- /*Indicate to the browser to ignore this upcomming location change since we're making it programmatically*/
295
- that.ignoreLocationChange = true;
296
-
297
- /*Indicate to IE that this is an atomic location change block*/
298
- that.ieAtomicLocationChange = true;
299
-
300
- /*Save this as our current location*/
301
- that.currentLocation = encodedLocation;
302
-
303
- /*Change the browser location*/
304
- window.location.hash = encodedLocation;
305
-
306
- /*Change the hidden iframe's location if on IE*/
307
- if (that.isIE) {
308
- that.iframe.src = that.blankURL + encodedLocation;
309
- }
310
-
311
- /*End of atomic location change block for IE*/
312
- that.ieAtomicLocationChange = false;
313
-
314
- that.changeTitle(historyData);
315
-
316
- };
317
-
318
- /*Now queue up this add request*/
319
- window.setTimeout(addImpl, this.currentWaitTime);
320
-
321
- /*Indicate that the next request will have to wait for awhile*/
322
- this.currentWaitTime = this.currentWaitTime + this.waitTime;
323
- }
324
- },
325
-
326
- /*Public*/
327
- isFirstLoad: function() {
328
- return this.firstLoad;
329
- },
330
-
331
- /*Public*/
332
- getVersion: function() {
333
- return this.VERSIONNUMBER;
334
- },
335
-
336
- /*- - - - - - - - - - - -*/
337
-
338
- /*Private: Constant for our own internal history event called when the page is loaded*/
339
- PAGELOADEDSTRING: "DhtmlHistory_pageLoaded",
340
-
341
- VERSIONNUMBER: "0.8",
342
-
343
- /*
344
- Private: Pattern for title changes. Example: "Armchair DJ [@@@]" where @@@ will be relaced by values passed to add();
345
- Default is just the title itself, hence "@@@"
346
- */
347
- baseTitle: "@@@",
348
-
349
- /*Private: Placeholder variable for the original document title; will be set in ititialize()*/
350
- originalTitle: null,
351
-
352
- /*Private: URL for the blank html file we use for IE; can be overridden via the options bundle. Otherwise it must be served
353
- in same directory as this library*/
354
- blankURL: "/blank.html?",
355
-
356
- /*Private: Our history change listener.*/
357
- listener: null,
358
-
359
- /*Private: MS to wait between add requests - will be reset for certain browsers*/
360
- waitTime: 200,
361
-
362
- /*Private: MS before an add request can execute*/
363
- currentWaitTime: 0,
364
-
365
- /*Private: Our current hash location, without the "#" symbol.*/
366
- currentLocation: null,
367
-
368
- /*Private: Hidden iframe used to IE to detect history changes*/
369
- iframe: null,
370
-
371
- /*Private: Flags and DOM references used only by Safari*/
372
- safariHistoryStartPoint: null,
373
- safariStack: null,
374
- safariLength: null,
375
-
376
- /*Private: Flag used to keep checkLocation() from doing anything when it discovers location changes we've made ourselves
377
- programmatically with the add() method. Basically, add() sets this to true. When checkLocation() discovers it's true,
378
- it refrains from firing our listener, then resets the flag to false for next cycle. That way, our listener only gets fired on
379
- history change events triggered by the user via back/forward buttons and manual hash changes. This flag also helps us set up
380
- IE's special iframe-based method of handling history changes.*/
381
- ignoreLocationChange: null,
382
-
383
- /*Private: A flag that indicates that we should fire a history change event when we are ready, i.e. after we are initialized and
384
- we have a history change listener. This is needed due to an edge case in browsers other than IE; if you leave a page entirely
385
- then return, we must fire this as a history change event. Unfortunately, we have lost all references to listeners from earlier,
386
- because JavaScript clears out.*/
387
- fireOnNewListener: null,
388
-
389
- /*Private: A variable that indicates whether this is the first time this page has been loaded. If you go to a web page, leave it
390
- for another one, and then return, the page's onload listener fires again. We need a way to differentiate between the first page
391
- load and subsequent ones. This variable works hand in hand with the pageLoaded variable we store into historyStorage.*/
392
- firstLoad: null,
393
-
394
- /*Private: A variable to handle an important edge case in IE. In IE, if a user manually types an address into their browser's
395
- location bar, we must intercept this by calling checkLocation() at regular intervals. However, if we are programmatically
396
- changing the location bar ourselves using the add() method, we need to ignore these changes in checkLocation(). Unfortunately,
397
- these changes take several lines of code to complete, so for the duration of those lines of code, we set this variable to true.
398
- That signals to checkLocation() to ignore the change-in-progress. Once we're done with our chunk of location-change code in
399
- add(), we set this back to false. We'll do the same thing when capturing user-entered address changes in checkLocation itself.*/
400
- ieAtomicLocationChange: null,
401
-
402
- /*Private: Generic utility function for attaching events*/
403
- addEventListener: function(o,e,l) {
404
- if (o.addEventListener) {
405
- o.addEventListener(e,l,false);
406
- } else if (o.attachEvent) {
407
- o.attachEvent('on'+e,function() {
408
- l(window.event);
409
- });
410
- }
411
- },
412
-
413
-
414
- /*Private: Create IE-specific DOM nodes and overrides*/
415
- createIE: function(initialHash) {
416
- /*write out a hidden iframe for IE and set the amount of time to wait between add() requests*/
417
- this.waitTime = 400;/*IE needs longer between history updates*/
418
- var styles = (historyStorage.debugMode
419
- ? 'width: 800px;height:80px;border:1px solid black;'
420
- : historyStorage.hideStyles
421
- );
422
- var iframeID = "rshHistoryFrame";
423
- var iframeHTML = '<iframe frameborder="0" id="' + iframeID + '" style="' + styles + '" src="' + this.blankURL + initialHash + '"></iframe>';
424
- document.write(iframeHTML);
425
- this.iframe = document.getElementById(iframeID);
426
- },
427
-
428
- /*Private: Create Opera-specific DOM nodes and overrides*/
429
- createOpera: function() {
430
- this.waitTime = 400;/*Opera needs longer between history updates*/
431
- var imgHTML = '<img src="javascript:location.href=\'javascript:dhtmlHistory.checkLocation();\';" style="' + historyStorage.hideStyles + '" />';
432
- document.write(imgHTML);
433
- },
434
-
435
- /*Private: Create Safari-specific DOM nodes and overrides*/
436
- createSafari: function() {
437
- var formID = "rshSafariForm";
438
- var stackID = "rshSafariStack";
439
- var lengthID = "rshSafariLength";
440
- var formStyles = historyStorage.debugMode ? historyStorage.showStyles : historyStorage.hideStyles;
441
- var stackStyles = (historyStorage.debugMode
442
- ? 'width: 800px;height:80px;border:1px solid black;'
443
- : historyStorage.hideStyles
444
- );
445
- var lengthStyles = (historyStorage.debugMode
446
- ? 'width:800px;height:20px;border:1px solid black;margin:0;padding:0;'
447
- : historyStorage.hideStyles
448
- );
449
- var safariHTML = '<form id="' + formID + '" style="' + formStyles + '">'
450
- + '<textarea style="' + stackStyles + '" id="' + stackID + '">[]</textarea>'
451
- + '<input type="text" style="' + lengthStyles + '" id="' + lengthID + '" value=""/>'
452
- + '</form>';
453
- document.write(safariHTML);
454
- this.safariStack = document.getElementById(stackID);
455
- this.safariLength = document.getElementById(lengthID);
456
- if (!historyStorage.hasKey(this.PAGELOADEDSTRING)) {
457
- this.safariHistoryStartPoint = history.length;
458
- this.safariLength.value = this.safariHistoryStartPoint;
459
- } else {
460
- this.safariHistoryStartPoint = this.safariLength.value;
461
- }
462
- },
463
-
464
- /*TODO: make this public again?*/
465
- /*Private: Get browser's current hash location; for Safari, read value from a hidden form field*/
466
- getCurrentLocation: function() {
467
- var r = (this.isSafari
468
- ? this.getSafariState()
469
- : this.getCurrentHash()
470
- );
471
- return r;
472
- },
473
-
474
- /*TODO: make this public again?*/
475
- /*Private: Manually parse the current url for a hash; tip of the hat to YUI*/
476
- getCurrentHash: function() {
477
- var r = window.location.href;
478
- var i = r.indexOf("#");
479
- return (i >= 0
480
- ? r.substr(i+1)
481
- : ""
482
- );
483
- },
484
-
485
- /*Private: Safari method to read the history stack from a hidden form field*/
486
- getSafariStack: function() {
487
- var r = this.safariStack.value;
488
- return historyStorage.fromJSON(r);
489
- },
490
- /*Private: Safari method to read from the history stack*/
491
- getSafariState: function() {
492
- var stack = this.getSafariStack();
493
- var state = stack[history.length - this.safariHistoryStartPoint - 1];
494
- return state;
495
- },
496
- /*Private: Safari method to write the history stack to a hidden form field*/
497
- putSafariState: function(newLocation) {
498
- var stack = this.getSafariStack();
499
- stack[history.length - this.safariHistoryStartPoint] = newLocation;
500
- this.safariStack.value = historyStorage.toJSON(stack);
501
- },
502
-
503
- /*Private: Notify the listener of new history changes.*/
504
- fireHistoryEvent: function(newHash) {
505
- var decodedHash = decodeURI(newHash)
506
- /*extract the value from our history storage for this hash*/
507
- var historyData = historyStorage.get(decodedHash);
508
- this.changeTitle(historyData);
509
- /*call our listener*/
510
- this.listener.call(null, decodedHash, historyData);
511
- },
512
-
513
- /*Private: See if the browser has changed location. This is the primary history mechanism for Firefox. For IE, we use this to
514
- handle an important edge case: if a user manually types in a new hash value into their IE location bar and press enter, we want to
515
- to intercept this and notify any history listener.*/
516
- checkLocation: function() {
517
-
518
- /*Ignore any location changes that we made ourselves for browsers other than IE*/
519
- if (!this.isIE && this.ignoreLocationChange) {
520
- this.ignoreLocationChange = false;
521
- return;
522
- }
523
-
524
- /*If we are dealing with IE and we are in the middle of making a location change from an iframe, ignore it*/
525
- if (!this.isIE && this.ieAtomicLocationChange) {
526
- return;
527
- }
528
-
529
- /*Get hash location*/
530
- var hash = this.getCurrentLocation();
531
-
532
- /*Do nothing if there's been no change*/
533
- if (hash == this.currentLocation) {
534
- return;
535
- }
536
-
537
- /*In IE, users manually entering locations into the browser; we do this by comparing the browser's location against the
538
- iframe's location; if they differ, we are dealing with a manual event and need to place it inside our history, otherwise
539
- we can return*/
540
- this.ieAtomicLocationChange = true;
541
-
542
- if (this.isIE && this.getIframeHash() != hash) {
543
- this.iframe.src = this.blankURL + hash;
544
- }
545
- else if (this.isIE) {
546
- /*the iframe is unchanged*/
547
- return;
548
- }
549
-
550
- /*Save this new location*/
551
- this.currentLocation = hash;
552
-
553
- this.ieAtomicLocationChange = false;
554
-
555
- /*Notify listeners of the change*/
556
- this.fireHistoryEvent(hash);
557
- },
558
-
559
- /*Private: Get the current location of IE's hidden iframe.*/
560
- getIframeHash: function() {
561
- var doc = this.iframe.contentWindow.document;
562
- var hash = String(doc.location.search);
563
- if (hash.length == 1 && hash.charAt(0) == "?") {
564
- hash = "";
565
- }
566
- else if (hash.length >= 2 && hash.charAt(0) == "?") {
567
- hash = hash.substring(1);
568
- }
569
- return hash;
570
- },
571
-
572
- /*Private: Remove any leading hash that might be on a location.*/
573
- removeHash: function(hashValue) {
574
- var r;
575
- if (hashValue === null || hashValue === undefined) {
576
- r = null;
577
- }
578
- else if (hashValue === "") {
579
- r = "";
580
- }
581
- else if (hashValue.length == 1 && hashValue.charAt(0) == "#") {
582
- r = "";
583
- }
584
- else if (hashValue.length > 1 && hashValue.charAt(0) == "#") {
585
- r = hashValue.substring(1);
586
- }
587
- else {
588
- r = hashValue;
589
- }
590
- return r;
591
- },
592
-
593
- /*Private: For IE, tell when the hidden iframe has finished loading.*/
594
- iframeLoaded: function(newLocation) {
595
- /*ignore any location changes that we made ourselves*/
596
- if (this.ignoreLocationChange) {
597
- this.ignoreLocationChange = false;
598
- return;
599
- }
600
-
601
- /*Get the new location*/
602
- var hash = String(newLocation.search);
603
- if (hash.length == 1 && hash.charAt(0) == "?") {
604
- hash = "";
605
- }
606
- else if (hash.length >= 2 && hash.charAt(0) == "?") {
607
- hash = hash.substring(1);
608
- }
609
- /*Keep the browser location bar in sync with the iframe hash*/
610
- window.location.hash = hash;
611
-
612
- /*Notify listeners of the change*/
613
- this.fireHistoryEvent(hash);
614
- }
615
-
616
-
617
- };
618
-
619
- /*
620
- historyStorage: An object that uses a hidden form to store history state across page loads. The mechanism for doing so relies on
621
- the fact that browsers save the text in form data for the life of the browser session, which means the text is still there when
622
- the user navigates back to the page. This object can be used independently of the dhtmlHistory object for caching of Ajax
623
- session information.
624
-
625
- dependencies:
626
- * json2007.js (included in a separate file) or alternate JSON methods passed in through an options bundle.
627
- */
628
- window.historyStorage = {
629
-
630
- /*Public: Set up our historyStorage object for use by dhtmlHistory or other objects*/
631
- setup: function(options) {
632
-
633
- /*
634
- options - object to store initialization parameters - passed in from dhtmlHistory or directly into historyStorage
635
- options.debugMode - boolean that causes hidden form fields to be shown for development purposes.
636
- options.toJSON - function to override default JSON stringifier
637
- options.fromJSON - function to override default JSON parser
638
- */
639
-
640
- /*process init parameters*/
641
- if (typeof options !== "undefined") {
642
- if (options.debugMode) {
643
- this.debugMode = options.debugMode;
644
- }
645
- if (options.toJSON) {
646
- this.toJSON = options.toJSON;
647
- }
648
- if (options.fromJSON) {
649
- this.fromJSON = options.fromJSON;
650
- }
651
- }
652
-
653
- /*write a hidden form and textarea into the page; we'll stow our history stack here*/
654
- var formID = "rshStorageForm";
655
- var textareaID = "rshStorageField";
656
- var formStyles = this.debugMode ? historyStorage.showStyles : historyStorage.hideStyles;
657
- var textareaStyles = (historyStorage.debugMode
658
- ? 'width: 800px;height:80px;border:1px solid black;'
659
- : historyStorage.hideStyles
660
- );
661
- var textareaHTML = '<form id="' + formID + '" style="' + formStyles + '">'
662
- + '<textarea id="' + textareaID + '" style="' + textareaStyles + '"></textarea>'
663
- + '</form>';
664
- document.write(textareaHTML);
665
- this.storageField = document.getElementById(textareaID);
666
- if (typeof window.opera !== "undefined") {
667
- this.storageField.focus();/*Opera needs to focus this element before persisting values in it*/
668
- }
669
- },
670
-
671
- /*Public*/
672
- put: function(key, value) {
673
-
674
- var encodedKey = encodeURI(key);
675
-
676
- this.assertValidKey(encodedKey);
677
- /*if we already have a value for this, remove the value before adding the new one*/
678
- if (this.hasKey(key)) {
679
- this.remove(key);
680
- }
681
- /*store this new key*/
682
- this.storageHash[encodedKey] = value;
683
- /*save and serialize the hashtable into the form*/
684
- this.saveHashTable();
685
- },
686
-
687
- /*Public*/
688
- get: function(key) {
689
-
690
- var encodedKey = encodeURI(key);
691
-
692
- this.assertValidKey(encodedKey);
693
- /*make sure the hash table has been loaded from the form*/
694
- this.loadHashTable();
695
- var value = this.storageHash[encodedKey];
696
- if (value === undefined) {
697
- value = null;
698
- }
699
- return value;
700
- },
701
-
702
- /*Public*/
703
- remove: function(key) {
704
-
705
- var encodedKey = encodeURI(key);
706
-
707
- this.assertValidKey(encodedKey);
708
- /*make sure the hash table has been loaded from the form*/
709
- this.loadHashTable();
710
- /*delete the value*/
711
- delete this.storageHash[encodedKey];
712
- /*serialize and save the hash table into the form*/
713
- this.saveHashTable();
714
- },
715
-
716
- /*Public: Clears out all saved data.*/
717
- reset: function() {
718
- this.storageField.value = "";
719
- this.storageHash = {};
720
- },
721
-
722
- /*Public*/
723
- hasKey: function(key) {
724
-
725
- var encodedKey = encodeURI(key);
726
-
727
- this.assertValidKey(encodedKey);
728
- /*make sure the hash table has been loaded from the form*/
729
- this.loadHashTable();
730
- return (typeof this.storageHash[encodedKey] !== "undefined");
731
- },
732
-
733
- /*Public*/
734
- isValidKey: function(key) {
735
- return (typeof key === "string");
736
- //TODO - should we ban hash signs and other special characters?
737
- },
738
-
739
- /*- - - - - - - - - - - -*/
740
-
741
- /*Private - CSS strings utilized by both objects to hide or show behind-the-scenes DOM elements*/
742
- showStyles: 'border:0;margin:0;padding:0;',
743
- hideStyles: 'left:-1000px;top:-1000px;width:1px;height:1px;border:0;position:absolute;',
744
-
745
- /*Private - debug mode flag*/
746
- debugMode: false,
747
-
748
- /*Private: Our hash of key name/values.*/
749
- storageHash: {},
750
-
751
- /*Private: If true, we have loaded our hash table out of the storage form.*/
752
- hashLoaded: false,
753
-
754
- /*Private: DOM reference to our history field*/
755
- storageField: null,
756
-
757
- /*Private: Assert that a key is valid; throw an exception if it not.*/
758
- assertValidKey: function(key) {
759
- var isValid = this.isValidKey(key);
760
- if (!isValid && this.debugMode) {
761
- throw new Error("Please provide a valid key for window.historyStorage. Invalid key = " + key + ".");
762
- }
763
- },
764
-
765
- /*Private: Load the hash table up from the form.*/
766
- loadHashTable: function() {
767
- if (!this.hashLoaded) {
768
- var serializedHashTable = this.storageField.value;
769
- if (serializedHashTable !== "" && serializedHashTable !== null) {
770
- this.storageHash = this.fromJSON(serializedHashTable);
771
- this.hashLoaded = true;
772
- }
773
- }
774
- },
775
- /*Private: Save the hash table into the form.*/
776
- saveHashTable: function() {
777
- this.loadHashTable();
778
- var serializedHashTable = this.toJSON(this.storageHash);
779
- this.storageField.value = serializedHashTable;
780
- },
781
- /*Private: Bridges for our JSON implementations - both rely on 2007 JSON.org library - can be overridden by options bundle*/
782
- toJSON: function(o) {
783
- return o.toJSONString();
784
- },
785
- fromJSON: function(s) {
786
- return s.parseJSON();
787
- }
788
- };
789
-
790
-
791
- /*******************************************************************/
792
- /** QueryString Object from http://adamv.com/dev/javascript/querystring */
793
- /* Client-side access to querystring name=value pairs
794
- Version 1.3
795
- 28 May 2008
796
-
797
- License (Simplified BSD):
798
- http://adamv.com/dev/javascript/qslicense.txt
799
- */
800
- function Querystring(qs) { // optionally pass a querystring to parse
801
- this.params = {};
802
-
803
- if (qs == null) qs = location.search.substring(1, location.search.length);
804
- if (qs.length == 0) return;
805
-
806
- // Turn <plus> back to <space>
807
- // See: http://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13.4.1
808
- qs = qs.replace(/\+/g, ' ');
809
- var args = qs.split('&'); // parse out name/value pairs separated via &
810
-
811
- // split out each name=value pair
812
- for (var i = 0; i < args.length; i++) {
813
- var pair = args[i].split('=');
814
- var name = decodeURI(pair[0]);
815
-
816
- var value = (pair.length==2)
817
- ? decodeURI(pair[1])
818
- : name;
819
-
820
- this.params[name] = value;
821
- }
822
- }
823
-
824
- Querystring.prototype.get = function(key, default_) {
825
- var value = this.params[key];
826
- return (value != null) ? value : default_;
827
- }
828
-
829
- Querystring.prototype.contains = function(key) {
830
- var value = this.params[key];
831
- return (value != null);
832
- }
833
-
834
- /*******************************************************************/
835
- /* Added by Ed Wildgoose - MailASail */
836
- /* Initialise the library and add our history callback */
837
- /*******************************************************************/
838
- window.dhtmlHistory.create({
839
- toJSON: function(o) {
840
- return Object.toJSON(o);
841
- }
842
- , fromJSON: function(s) {
843
- return s.evalJSON();
844
- }
845
-
846
- // Enable this to assist with debugging
847
- // , debugMode: true
848
-
849
- // dhtmlHistory has been modified not to need the next line
850
- // But left in for robustness when updating dhtmlHistory
851
- , blankURL: '/blank.html?'
852
- });
853
-
854
- /** Our callback to receive history
855
- change events. */
856
- var handleHistoryChange = function(pageId, pageData) {
857
- if (!pageData) return;
858
- var info = pageId.split(':');
859
- var id = info[0];
860
- pageData += '&_method=get';
861
- new Ajax.Request(pageData, {asynchronous:true, evalScripts:true, method: 'get', onLoading:function(request){Element.show(id+'-pagination-loading-indicator');}});
862
- }
863
-
864
- window.onload = function() {
865
- dhtmlHistory.initialize(handleHistoryChange);
866
- };
867
-