@@ -14,228 +14,228 @@ |
||
14 | 14 | */ |
15 | 15 | class I18nRegistry |
16 | 16 | { |
17 | - /** |
|
18 | - * @var DomainInterface |
|
19 | - */ |
|
20 | - private $domain; |
|
21 | - |
|
22 | - /** |
|
23 | - * Will hold all registered i18n scripts. |
|
24 | - * |
|
25 | - * @var array |
|
26 | - */ |
|
27 | - private $registered_i18n = array(); |
|
28 | - |
|
29 | - |
|
30 | - /** |
|
31 | - * Used to hold queued translations for the chunks loading in a view. |
|
32 | - * |
|
33 | - * @var array |
|
34 | - */ |
|
35 | - private $queued_handle_translations = array(); |
|
36 | - |
|
37 | - |
|
38 | - /** |
|
39 | - * Obtained from the generated json file from the all javascript using wp.i18n with a map of script handle names to |
|
40 | - * translation strings. |
|
41 | - * |
|
42 | - * @var array |
|
43 | - */ |
|
44 | - private $i18n_map; |
|
45 | - |
|
46 | - |
|
47 | - /** |
|
48 | - * I18nRegistry constructor. |
|
49 | - * |
|
50 | - * @param array() $i18n_map An array of script handle names and the strings translated for those handles. If not |
|
51 | - * provided, the class will look for map in root of plugin with filename of |
|
52 | - * 'translation-map.json'. |
|
53 | - * @param DomainInterface $domain |
|
54 | - */ |
|
55 | - public function __construct(array $i18n_map = array(), DomainInterface $domain) |
|
56 | - { |
|
57 | - $this->domain = $domain; |
|
58 | - $this->setI18nMap($i18n_map); |
|
59 | - add_filter('print_scripts_array', array($this, 'queueI18n')); |
|
60 | - } |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * Used to register a script that has i18n strings for its $handle |
|
65 | - * |
|
66 | - * @param string $handle The script handle reference. |
|
67 | - * @param string $domain The i18n domain for the strings. |
|
68 | - */ |
|
69 | - public function registerScriptI18n($handle, $domain = 'event_espresso') |
|
70 | - { |
|
71 | - $this->registered_i18n[$handle] = $domain; |
|
72 | - } |
|
73 | - |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * Callback on print_scripts_array to listen for scripts enqueued and handle setting up the localized data. |
|
78 | - * |
|
79 | - * @param array $handles Array of registered script handles. |
|
80 | - * @return array |
|
81 | - */ |
|
82 | - public function queueI18n(array $handles) |
|
83 | - { |
|
84 | - if (empty($this->registered_i18n) || empty($this->i18n_map)) { |
|
85 | - return $handles; |
|
86 | - } |
|
87 | - foreach ($handles as $handle) { |
|
88 | - $this->queueI18nTranslationsForHandle($handle); |
|
89 | - } |
|
90 | - if ($this->queued_handle_translations) { |
|
91 | - foreach ($this->queued_handle_translations as $handle => $translations_for_domain) { |
|
92 | - $this->registerInlineScript( |
|
93 | - $handle, |
|
94 | - $translations_for_domain['translations'], |
|
95 | - $translations_for_domain['domain'] |
|
96 | - ); |
|
97 | - } |
|
98 | - } |
|
99 | - return $handles; |
|
100 | - } |
|
101 | - |
|
102 | - |
|
103 | - /** |
|
104 | - * Registers inline script with translations for given handle and domain. |
|
105 | - * |
|
106 | - * @param string $handle Handle used to register javascript file containing translations. |
|
107 | - * @param array $translations Array of string translations. |
|
108 | - * @param string $domain Domain for translations. If left empty then strings are registered with the default |
|
109 | - * domain for the javascript. |
|
110 | - */ |
|
111 | - private function registerInlineScript($handle, array $translations, $domain) |
|
112 | - { |
|
113 | - $script = $domain ? |
|
114 | - 'wp.i18n.setLocaleData( ' . wp_json_encode($translations) . ', ' . $domain . ' );' : |
|
115 | - 'wp.i18n.setLocaleData( ' . wp_json_encode($translations) . ' );'; |
|
116 | - wp_add_inline_script($handle, $script, 'before'); |
|
117 | - } |
|
118 | - |
|
119 | - |
|
120 | - /** |
|
121 | - * Queues up the translation strings for the given handle. |
|
122 | - * |
|
123 | - * @param string $handle The script handle being queued up. |
|
124 | - */ |
|
125 | - private function queueI18nTranslationsForHandle($handle) |
|
126 | - { |
|
127 | - if (isset($this->registered_i18n[$handle])) { |
|
128 | - $domain = $this->registered_i18n[$handle]; |
|
129 | - $translations = $this->getJedLocaleDataForDomainAndChunk($handle, $domain); |
|
130 | - if (count($translations) > 1) { |
|
131 | - $this->queued_handle_translations[$handle] = array( |
|
132 | - 'domain' => $domain, |
|
133 | - 'translations' => $translations, |
|
134 | - ); |
|
135 | - } |
|
136 | - unset($this->registered_i18n[$handle]); |
|
137 | - } |
|
138 | - } |
|
139 | - |
|
140 | - |
|
141 | - /** |
|
142 | - * Sets the internal i18n_map property. |
|
143 | - * If $chunk_map is empty or not an array, will attempt to load a chunk map from a default named map. |
|
144 | - * |
|
145 | - * @param array $i18n_map If provided, an array of translation strings indexed by script handle names they |
|
146 | - * correspond to. |
|
147 | - */ |
|
148 | - private function setI18nMap(array $i18n_map) |
|
149 | - { |
|
150 | - if (empty($i18n_map)) { |
|
151 | - $i18n_map = file_exists($this->domain->pluginPath() . 'translation-map.json') |
|
152 | - ? json_decode( |
|
153 | - file_get_contents($this->domain->pluginPath() . 'translation-map.json'), |
|
154 | - true |
|
155 | - ) |
|
156 | - : array(); |
|
157 | - } |
|
158 | - $this->i18n_map = $i18n_map; |
|
159 | - } |
|
160 | - |
|
161 | - |
|
162 | - /** |
|
163 | - * Get the jed locale data for a given $handle and domain |
|
164 | - * |
|
165 | - * @param string $handle The name for the script handle we want strings returned for. |
|
166 | - * @param string $domain The i18n domain. |
|
167 | - * @return array |
|
168 | - */ |
|
169 | - protected function getJedLocaleDataForDomainAndChunk($handle, $domain) |
|
170 | - { |
|
171 | - $translations = $this->getJedLocaleData($domain); |
|
172 | - // get index for adding back after extracting strings for this $chunk. |
|
173 | - $index = $translations['']; |
|
174 | - $translations = $this->getLocaleDataMatchingMap( |
|
175 | - $this->getOriginalStringsForHandleFromMap($handle), |
|
176 | - $translations |
|
177 | - ); |
|
178 | - $translations[''] = $index; |
|
179 | - return $translations; |
|
180 | - } |
|
181 | - |
|
182 | - |
|
183 | - /** |
|
184 | - * Get locale data for given strings from given translations |
|
185 | - * |
|
186 | - * @param array $string_set This is the subset of strings (msgIds) we want to extract from the translations array. |
|
187 | - * @param array $translations Translation data to extra strings from. |
|
188 | - * @return array |
|
189 | - */ |
|
190 | - protected function getLocaleDataMatchingMap(array $string_set, array $translations) |
|
191 | - { |
|
192 | - if (empty($string_set)) { |
|
193 | - return array(); |
|
194 | - } |
|
195 | - // some strings with quotes in them will break on the array_flip, so making sure quotes in the string are |
|
196 | - // slashed also filter falsey values. |
|
197 | - $string_set = array_unique(array_filter(wp_slash($string_set))); |
|
198 | - return array_intersect_key($translations, array_flip($string_set)); |
|
199 | - } |
|
200 | - |
|
201 | - |
|
202 | - /** |
|
203 | - * Get original strings to translate for the given chunk from the map |
|
204 | - * |
|
205 | - * @param string $handle The script handle name to get strings from the map for. |
|
206 | - * @return array |
|
207 | - */ |
|
208 | - protected function getOriginalStringsForHandleFromMap($handle) |
|
209 | - { |
|
210 | - return isset($this->i18n_map[$handle]) ? $this->i18n_map[$handle] : array(); |
|
211 | - } |
|
212 | - |
|
213 | - |
|
214 | - /** |
|
215 | - * Returns Jed-formatted localization data. |
|
216 | - * |
|
217 | - * @param string $domain Translation domain. |
|
218 | - * @return array |
|
219 | - */ |
|
220 | - private function getJedLocaleData($domain) |
|
221 | - { |
|
222 | - $translations = get_translations_for_domain($domain); |
|
223 | - |
|
224 | - $locale = array( |
|
225 | - '' => array( |
|
226 | - 'domain' => $domain, |
|
227 | - 'lang' => is_admin() ? get_user_locale() : get_locale(), |
|
228 | - ), |
|
229 | - ); |
|
230 | - |
|
231 | - if (! empty($translations->headers['Plural-Forms'])) { |
|
232 | - $locale['']['plural_forms'] = $translations->headers['Plural-Forms']; |
|
233 | - } |
|
234 | - |
|
235 | - foreach ($translations->entries as $msgid => $entry) { |
|
236 | - $locale[$msgid] = $entry->translations; |
|
237 | - } |
|
238 | - |
|
239 | - return $locale; |
|
240 | - } |
|
17 | + /** |
|
18 | + * @var DomainInterface |
|
19 | + */ |
|
20 | + private $domain; |
|
21 | + |
|
22 | + /** |
|
23 | + * Will hold all registered i18n scripts. |
|
24 | + * |
|
25 | + * @var array |
|
26 | + */ |
|
27 | + private $registered_i18n = array(); |
|
28 | + |
|
29 | + |
|
30 | + /** |
|
31 | + * Used to hold queued translations for the chunks loading in a view. |
|
32 | + * |
|
33 | + * @var array |
|
34 | + */ |
|
35 | + private $queued_handle_translations = array(); |
|
36 | + |
|
37 | + |
|
38 | + /** |
|
39 | + * Obtained from the generated json file from the all javascript using wp.i18n with a map of script handle names to |
|
40 | + * translation strings. |
|
41 | + * |
|
42 | + * @var array |
|
43 | + */ |
|
44 | + private $i18n_map; |
|
45 | + |
|
46 | + |
|
47 | + /** |
|
48 | + * I18nRegistry constructor. |
|
49 | + * |
|
50 | + * @param array() $i18n_map An array of script handle names and the strings translated for those handles. If not |
|
51 | + * provided, the class will look for map in root of plugin with filename of |
|
52 | + * 'translation-map.json'. |
|
53 | + * @param DomainInterface $domain |
|
54 | + */ |
|
55 | + public function __construct(array $i18n_map = array(), DomainInterface $domain) |
|
56 | + { |
|
57 | + $this->domain = $domain; |
|
58 | + $this->setI18nMap($i18n_map); |
|
59 | + add_filter('print_scripts_array', array($this, 'queueI18n')); |
|
60 | + } |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * Used to register a script that has i18n strings for its $handle |
|
65 | + * |
|
66 | + * @param string $handle The script handle reference. |
|
67 | + * @param string $domain The i18n domain for the strings. |
|
68 | + */ |
|
69 | + public function registerScriptI18n($handle, $domain = 'event_espresso') |
|
70 | + { |
|
71 | + $this->registered_i18n[$handle] = $domain; |
|
72 | + } |
|
73 | + |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * Callback on print_scripts_array to listen for scripts enqueued and handle setting up the localized data. |
|
78 | + * |
|
79 | + * @param array $handles Array of registered script handles. |
|
80 | + * @return array |
|
81 | + */ |
|
82 | + public function queueI18n(array $handles) |
|
83 | + { |
|
84 | + if (empty($this->registered_i18n) || empty($this->i18n_map)) { |
|
85 | + return $handles; |
|
86 | + } |
|
87 | + foreach ($handles as $handle) { |
|
88 | + $this->queueI18nTranslationsForHandle($handle); |
|
89 | + } |
|
90 | + if ($this->queued_handle_translations) { |
|
91 | + foreach ($this->queued_handle_translations as $handle => $translations_for_domain) { |
|
92 | + $this->registerInlineScript( |
|
93 | + $handle, |
|
94 | + $translations_for_domain['translations'], |
|
95 | + $translations_for_domain['domain'] |
|
96 | + ); |
|
97 | + } |
|
98 | + } |
|
99 | + return $handles; |
|
100 | + } |
|
101 | + |
|
102 | + |
|
103 | + /** |
|
104 | + * Registers inline script with translations for given handle and domain. |
|
105 | + * |
|
106 | + * @param string $handle Handle used to register javascript file containing translations. |
|
107 | + * @param array $translations Array of string translations. |
|
108 | + * @param string $domain Domain for translations. If left empty then strings are registered with the default |
|
109 | + * domain for the javascript. |
|
110 | + */ |
|
111 | + private function registerInlineScript($handle, array $translations, $domain) |
|
112 | + { |
|
113 | + $script = $domain ? |
|
114 | + 'wp.i18n.setLocaleData( ' . wp_json_encode($translations) . ', ' . $domain . ' );' : |
|
115 | + 'wp.i18n.setLocaleData( ' . wp_json_encode($translations) . ' );'; |
|
116 | + wp_add_inline_script($handle, $script, 'before'); |
|
117 | + } |
|
118 | + |
|
119 | + |
|
120 | + /** |
|
121 | + * Queues up the translation strings for the given handle. |
|
122 | + * |
|
123 | + * @param string $handle The script handle being queued up. |
|
124 | + */ |
|
125 | + private function queueI18nTranslationsForHandle($handle) |
|
126 | + { |
|
127 | + if (isset($this->registered_i18n[$handle])) { |
|
128 | + $domain = $this->registered_i18n[$handle]; |
|
129 | + $translations = $this->getJedLocaleDataForDomainAndChunk($handle, $domain); |
|
130 | + if (count($translations) > 1) { |
|
131 | + $this->queued_handle_translations[$handle] = array( |
|
132 | + 'domain' => $domain, |
|
133 | + 'translations' => $translations, |
|
134 | + ); |
|
135 | + } |
|
136 | + unset($this->registered_i18n[$handle]); |
|
137 | + } |
|
138 | + } |
|
139 | + |
|
140 | + |
|
141 | + /** |
|
142 | + * Sets the internal i18n_map property. |
|
143 | + * If $chunk_map is empty or not an array, will attempt to load a chunk map from a default named map. |
|
144 | + * |
|
145 | + * @param array $i18n_map If provided, an array of translation strings indexed by script handle names they |
|
146 | + * correspond to. |
|
147 | + */ |
|
148 | + private function setI18nMap(array $i18n_map) |
|
149 | + { |
|
150 | + if (empty($i18n_map)) { |
|
151 | + $i18n_map = file_exists($this->domain->pluginPath() . 'translation-map.json') |
|
152 | + ? json_decode( |
|
153 | + file_get_contents($this->domain->pluginPath() . 'translation-map.json'), |
|
154 | + true |
|
155 | + ) |
|
156 | + : array(); |
|
157 | + } |
|
158 | + $this->i18n_map = $i18n_map; |
|
159 | + } |
|
160 | + |
|
161 | + |
|
162 | + /** |
|
163 | + * Get the jed locale data for a given $handle and domain |
|
164 | + * |
|
165 | + * @param string $handle The name for the script handle we want strings returned for. |
|
166 | + * @param string $domain The i18n domain. |
|
167 | + * @return array |
|
168 | + */ |
|
169 | + protected function getJedLocaleDataForDomainAndChunk($handle, $domain) |
|
170 | + { |
|
171 | + $translations = $this->getJedLocaleData($domain); |
|
172 | + // get index for adding back after extracting strings for this $chunk. |
|
173 | + $index = $translations['']; |
|
174 | + $translations = $this->getLocaleDataMatchingMap( |
|
175 | + $this->getOriginalStringsForHandleFromMap($handle), |
|
176 | + $translations |
|
177 | + ); |
|
178 | + $translations[''] = $index; |
|
179 | + return $translations; |
|
180 | + } |
|
181 | + |
|
182 | + |
|
183 | + /** |
|
184 | + * Get locale data for given strings from given translations |
|
185 | + * |
|
186 | + * @param array $string_set This is the subset of strings (msgIds) we want to extract from the translations array. |
|
187 | + * @param array $translations Translation data to extra strings from. |
|
188 | + * @return array |
|
189 | + */ |
|
190 | + protected function getLocaleDataMatchingMap(array $string_set, array $translations) |
|
191 | + { |
|
192 | + if (empty($string_set)) { |
|
193 | + return array(); |
|
194 | + } |
|
195 | + // some strings with quotes in them will break on the array_flip, so making sure quotes in the string are |
|
196 | + // slashed also filter falsey values. |
|
197 | + $string_set = array_unique(array_filter(wp_slash($string_set))); |
|
198 | + return array_intersect_key($translations, array_flip($string_set)); |
|
199 | + } |
|
200 | + |
|
201 | + |
|
202 | + /** |
|
203 | + * Get original strings to translate for the given chunk from the map |
|
204 | + * |
|
205 | + * @param string $handle The script handle name to get strings from the map for. |
|
206 | + * @return array |
|
207 | + */ |
|
208 | + protected function getOriginalStringsForHandleFromMap($handle) |
|
209 | + { |
|
210 | + return isset($this->i18n_map[$handle]) ? $this->i18n_map[$handle] : array(); |
|
211 | + } |
|
212 | + |
|
213 | + |
|
214 | + /** |
|
215 | + * Returns Jed-formatted localization data. |
|
216 | + * |
|
217 | + * @param string $domain Translation domain. |
|
218 | + * @return array |
|
219 | + */ |
|
220 | + private function getJedLocaleData($domain) |
|
221 | + { |
|
222 | + $translations = get_translations_for_domain($domain); |
|
223 | + |
|
224 | + $locale = array( |
|
225 | + '' => array( |
|
226 | + 'domain' => $domain, |
|
227 | + 'lang' => is_admin() ? get_user_locale() : get_locale(), |
|
228 | + ), |
|
229 | + ); |
|
230 | + |
|
231 | + if (! empty($translations->headers['Plural-Forms'])) { |
|
232 | + $locale['']['plural_forms'] = $translations->headers['Plural-Forms']; |
|
233 | + } |
|
234 | + |
|
235 | + foreach ($translations->entries as $msgid => $entry) { |
|
236 | + $locale[$msgid] = $entry->translations; |
|
237 | + } |
|
238 | + |
|
239 | + return $locale; |
|
240 | + } |
|
241 | 241 | } |
242 | 242 | \ No newline at end of file |
@@ -111,8 +111,7 @@ discard block |
||
111 | 111 | private function registerInlineScript($handle, array $translations, $domain) |
112 | 112 | { |
113 | 113 | $script = $domain ? |
114 | - 'wp.i18n.setLocaleData( ' . wp_json_encode($translations) . ', ' . $domain . ' );' : |
|
115 | - 'wp.i18n.setLocaleData( ' . wp_json_encode($translations) . ' );'; |
|
114 | + 'wp.i18n.setLocaleData( '.wp_json_encode($translations).', '.$domain.' );' : 'wp.i18n.setLocaleData( '.wp_json_encode($translations).' );'; |
|
116 | 115 | wp_add_inline_script($handle, $script, 'before'); |
117 | 116 | } |
118 | 117 | |
@@ -148,9 +147,9 @@ discard block |
||
148 | 147 | private function setI18nMap(array $i18n_map) |
149 | 148 | { |
150 | 149 | if (empty($i18n_map)) { |
151 | - $i18n_map = file_exists($this->domain->pluginPath() . 'translation-map.json') |
|
150 | + $i18n_map = file_exists($this->domain->pluginPath().'translation-map.json') |
|
152 | 151 | ? json_decode( |
153 | - file_get_contents($this->domain->pluginPath() . 'translation-map.json'), |
|
152 | + file_get_contents($this->domain->pluginPath().'translation-map.json'), |
|
154 | 153 | true |
155 | 154 | ) |
156 | 155 | : array(); |
@@ -228,7 +227,7 @@ discard block |
||
228 | 227 | ), |
229 | 228 | ); |
230 | 229 | |
231 | - if (! empty($translations->headers['Plural-Forms'])) { |
|
230 | + if ( ! empty($translations->headers['Plural-Forms'])) { |
|
232 | 231 | $locale['']['plural_forms'] = $translations->headers['Plural-Forms']; |
233 | 232 | } |
234 | 233 |
@@ -26,702 +26,702 @@ |
||
26 | 26 | class Registry |
27 | 27 | { |
28 | 28 | |
29 | - const ASSET_TYPE_CSS = 'css'; |
|
30 | - const ASSET_TYPE_JS = 'js'; |
|
31 | - const ASSET_NAMESPACE = 'core'; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var EE_Template_Config $template_config |
|
35 | - */ |
|
36 | - protected $template_config; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var EE_Currency_Config $currency_config |
|
40 | - */ |
|
41 | - protected $currency_config; |
|
42 | - |
|
43 | - /** |
|
44 | - * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script. |
|
45 | - * |
|
46 | - * @var array |
|
47 | - */ |
|
48 | - protected $jsdata = array(); |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * This keeps track of all scripts with registered data. It is used to prevent duplicate data objects setup in the |
|
53 | - * page source. |
|
54 | - * @var array |
|
55 | - */ |
|
56 | - protected $script_handles_with_data = array(); |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * @var DomainInterface |
|
61 | - */ |
|
62 | - protected $domain; |
|
63 | - |
|
64 | - |
|
65 | - /** |
|
66 | - * @var I18nRegistry |
|
67 | - */ |
|
68 | - private $i18n_registry; |
|
69 | - |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * Holds the manifest data obtained from registered manifest files. |
|
74 | - * Manifests are maps of asset chunk name to actual built asset file names. |
|
75 | - * Shape of this array is: |
|
76 | - * |
|
77 | - * array( |
|
78 | - * 'some_namespace_slug' => array( |
|
79 | - * 'some_chunk_name' => array( |
|
80 | - * 'js' => 'filename.js' |
|
81 | - * 'css' => 'filename.js' |
|
82 | - * ), |
|
83 | - * 'url_base' => 'https://baseurl.com/to/assets |
|
84 | - * ) |
|
85 | - * ) |
|
86 | - * |
|
87 | - * @var array |
|
88 | - */ |
|
89 | - private $manifest_data = array(); |
|
90 | - |
|
91 | - |
|
92 | - /** |
|
93 | - * Registry constructor. |
|
94 | - * Hooking into WP actions for script registry. |
|
95 | - * |
|
96 | - * @param EE_Template_Config $template_config |
|
97 | - * @param EE_Currency_Config $currency_config |
|
98 | - * @param I18nRegistry $i18n_registry |
|
99 | - * @param DomainInterface $domain |
|
100 | - * @throws InvalidArgumentException |
|
101 | - * @throws InvalidFilePathException |
|
102 | - */ |
|
103 | - public function __construct( |
|
104 | - EE_Template_Config $template_config, |
|
105 | - EE_Currency_Config $currency_config, |
|
106 | - I18nRegistry $i18n_registry, |
|
107 | - DomainInterface $domain |
|
108 | - ) { |
|
109 | - $this->template_config = $template_config; |
|
110 | - $this->currency_config = $currency_config; |
|
111 | - $this->domain = $domain; |
|
112 | - $this->i18n_registry = $i18n_registry; |
|
113 | - $this->registerManifestFile( |
|
114 | - self::ASSET_NAMESPACE, |
|
115 | - $this->domain->distributionAssetsUrl(), |
|
116 | - $this->domain->distributionAssetsPath() . 'build-manifest.json' |
|
117 | - ); |
|
118 | - add_action('wp_enqueue_scripts', array($this, 'scripts'), 1); |
|
119 | - add_action('admin_enqueue_scripts', array($this, 'scripts'), 1); |
|
120 | - add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 2); |
|
121 | - add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 2); |
|
122 | - add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1); |
|
123 | - add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1); |
|
124 | - } |
|
125 | - |
|
126 | - |
|
127 | - /** |
|
128 | - * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n |
|
129 | - * translation handling. |
|
130 | - * |
|
131 | - * @return I18nRegistry |
|
132 | - */ |
|
133 | - public function getI18nRegistry() |
|
134 | - { |
|
135 | - return $this->i18n_registry; |
|
136 | - } |
|
137 | - |
|
138 | - /** |
|
139 | - * Callback for the WP script actions. |
|
140 | - * Used to register globally accessible core scripts. |
|
141 | - * Also used to add the eejs.data object to the source for any js having eejs-core as a dependency. |
|
142 | - * |
|
143 | - */ |
|
144 | - public function scripts() |
|
145 | - { |
|
146 | - global $wp_version; |
|
147 | - wp_register_script( |
|
148 | - 'ee-manifest', |
|
149 | - $this->getJsUrl(self::ASSET_NAMESPACE, 'manifest'), |
|
150 | - array(), |
|
151 | - null, |
|
152 | - true |
|
153 | - ); |
|
154 | - wp_register_script( |
|
155 | - 'eejs-core', |
|
156 | - $this->getJsUrl(self::ASSET_NAMESPACE, 'eejs'), |
|
157 | - array('ee-manifest'), |
|
158 | - null, |
|
159 | - true |
|
160 | - ); |
|
161 | - wp_register_script( |
|
162 | - 'ee-vendor-react', |
|
163 | - $this->getJsUrl(self::ASSET_NAMESPACE, 'reactVendor'), |
|
164 | - array('eejs-core'), |
|
165 | - null, |
|
166 | - true |
|
167 | - ); |
|
168 | - //only run this if WordPress 4.4.0 > is in use. |
|
169 | - if (version_compare($wp_version, '4.4.0', '>')) { |
|
170 | - //js.api |
|
171 | - wp_register_script( |
|
172 | - 'eejs-api', |
|
173 | - EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js', |
|
174 | - array('underscore', 'eejs-core'), |
|
175 | - EVENT_ESPRESSO_VERSION, |
|
176 | - true |
|
177 | - ); |
|
178 | - $this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest'); |
|
179 | - $this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/')); |
|
180 | - } |
|
181 | - if (! is_admin()) { |
|
182 | - $this->loadCoreCss(); |
|
183 | - } |
|
184 | - $this->registerTranslationsForHandles(array('eejs-core')); |
|
185 | - $this->loadCoreJs(); |
|
186 | - $this->loadJqueryValidate(); |
|
187 | - $this->loadAccountingJs(); |
|
188 | - $this->loadQtipJs(); |
|
189 | - $this->registerAdminAssets(); |
|
190 | - } |
|
191 | - |
|
192 | - |
|
193 | - |
|
194 | - /** |
|
195 | - * Call back for the script print in frontend and backend. |
|
196 | - * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point. |
|
197 | - * |
|
198 | - * @since 4.9.31.rc.015 |
|
199 | - */ |
|
200 | - public function enqueueData() |
|
201 | - { |
|
202 | - $this->removeAlreadyRegisteredDataForScriptHandles(); |
|
203 | - wp_add_inline_script( |
|
204 | - 'eejs-core', |
|
205 | - 'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)), |
|
206 | - 'before' |
|
207 | - ); |
|
208 | - wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings); |
|
209 | - $this->localizeAccountingJs(); |
|
210 | - $this->addRegisteredScriptHandlesWithData('eejs-core'); |
|
211 | - $this->addRegisteredScriptHandlesWithData('espresso_core'); |
|
212 | - } |
|
213 | - |
|
214 | - |
|
215 | - |
|
216 | - /** |
|
217 | - * Used to add data to eejs.data object. |
|
218 | - * Note: Overriding existing data is not allowed. |
|
219 | - * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript. |
|
220 | - * If the data you add is something like this: |
|
221 | - * $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) ); |
|
222 | - * It will be exposed in the page source as: |
|
223 | - * eejs.data.my_plugin_data.foo == gar |
|
224 | - * |
|
225 | - * @param string $key Key used to access your data |
|
226 | - * @param string|array $value Value to attach to key |
|
227 | - * @throws InvalidArgumentException |
|
228 | - */ |
|
229 | - public function addData($key, $value) |
|
230 | - { |
|
231 | - if ($this->verifyDataNotExisting($key)) { |
|
232 | - $this->jsdata[$key] = $value; |
|
233 | - } |
|
234 | - } |
|
235 | - |
|
236 | - |
|
237 | - |
|
238 | - /** |
|
239 | - * Similar to addData except this allows for users to push values to an existing key where the values on key are |
|
240 | - * elements in an array. |
|
241 | - * When you use this method, the value you include will be appended to the end of an array on $key. |
|
242 | - * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript |
|
243 | - * object like this, eejs.data.test = [ my_data, |
|
244 | - * ] |
|
245 | - * If there has already been a scalar value attached to the data object given key, then |
|
246 | - * this will throw an exception. |
|
247 | - * |
|
248 | - * @param string $key Key to attach data to. |
|
249 | - * @param string|array $value Value being registered. |
|
250 | - * @throws InvalidArgumentException |
|
251 | - */ |
|
252 | - public function pushData($key, $value) |
|
253 | - { |
|
254 | - if (isset($this->jsdata[$key]) |
|
255 | - && ! is_array($this->jsdata[$key]) |
|
256 | - ) { |
|
257 | - throw new invalidArgumentException( |
|
258 | - sprintf( |
|
259 | - __( |
|
260 | - 'The value for %1$s is already set and it is not an array. The %2$s method can only be used to |
|
29 | + const ASSET_TYPE_CSS = 'css'; |
|
30 | + const ASSET_TYPE_JS = 'js'; |
|
31 | + const ASSET_NAMESPACE = 'core'; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var EE_Template_Config $template_config |
|
35 | + */ |
|
36 | + protected $template_config; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var EE_Currency_Config $currency_config |
|
40 | + */ |
|
41 | + protected $currency_config; |
|
42 | + |
|
43 | + /** |
|
44 | + * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script. |
|
45 | + * |
|
46 | + * @var array |
|
47 | + */ |
|
48 | + protected $jsdata = array(); |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * This keeps track of all scripts with registered data. It is used to prevent duplicate data objects setup in the |
|
53 | + * page source. |
|
54 | + * @var array |
|
55 | + */ |
|
56 | + protected $script_handles_with_data = array(); |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * @var DomainInterface |
|
61 | + */ |
|
62 | + protected $domain; |
|
63 | + |
|
64 | + |
|
65 | + /** |
|
66 | + * @var I18nRegistry |
|
67 | + */ |
|
68 | + private $i18n_registry; |
|
69 | + |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * Holds the manifest data obtained from registered manifest files. |
|
74 | + * Manifests are maps of asset chunk name to actual built asset file names. |
|
75 | + * Shape of this array is: |
|
76 | + * |
|
77 | + * array( |
|
78 | + * 'some_namespace_slug' => array( |
|
79 | + * 'some_chunk_name' => array( |
|
80 | + * 'js' => 'filename.js' |
|
81 | + * 'css' => 'filename.js' |
|
82 | + * ), |
|
83 | + * 'url_base' => 'https://baseurl.com/to/assets |
|
84 | + * ) |
|
85 | + * ) |
|
86 | + * |
|
87 | + * @var array |
|
88 | + */ |
|
89 | + private $manifest_data = array(); |
|
90 | + |
|
91 | + |
|
92 | + /** |
|
93 | + * Registry constructor. |
|
94 | + * Hooking into WP actions for script registry. |
|
95 | + * |
|
96 | + * @param EE_Template_Config $template_config |
|
97 | + * @param EE_Currency_Config $currency_config |
|
98 | + * @param I18nRegistry $i18n_registry |
|
99 | + * @param DomainInterface $domain |
|
100 | + * @throws InvalidArgumentException |
|
101 | + * @throws InvalidFilePathException |
|
102 | + */ |
|
103 | + public function __construct( |
|
104 | + EE_Template_Config $template_config, |
|
105 | + EE_Currency_Config $currency_config, |
|
106 | + I18nRegistry $i18n_registry, |
|
107 | + DomainInterface $domain |
|
108 | + ) { |
|
109 | + $this->template_config = $template_config; |
|
110 | + $this->currency_config = $currency_config; |
|
111 | + $this->domain = $domain; |
|
112 | + $this->i18n_registry = $i18n_registry; |
|
113 | + $this->registerManifestFile( |
|
114 | + self::ASSET_NAMESPACE, |
|
115 | + $this->domain->distributionAssetsUrl(), |
|
116 | + $this->domain->distributionAssetsPath() . 'build-manifest.json' |
|
117 | + ); |
|
118 | + add_action('wp_enqueue_scripts', array($this, 'scripts'), 1); |
|
119 | + add_action('admin_enqueue_scripts', array($this, 'scripts'), 1); |
|
120 | + add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 2); |
|
121 | + add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 2); |
|
122 | + add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1); |
|
123 | + add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1); |
|
124 | + } |
|
125 | + |
|
126 | + |
|
127 | + /** |
|
128 | + * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n |
|
129 | + * translation handling. |
|
130 | + * |
|
131 | + * @return I18nRegistry |
|
132 | + */ |
|
133 | + public function getI18nRegistry() |
|
134 | + { |
|
135 | + return $this->i18n_registry; |
|
136 | + } |
|
137 | + |
|
138 | + /** |
|
139 | + * Callback for the WP script actions. |
|
140 | + * Used to register globally accessible core scripts. |
|
141 | + * Also used to add the eejs.data object to the source for any js having eejs-core as a dependency. |
|
142 | + * |
|
143 | + */ |
|
144 | + public function scripts() |
|
145 | + { |
|
146 | + global $wp_version; |
|
147 | + wp_register_script( |
|
148 | + 'ee-manifest', |
|
149 | + $this->getJsUrl(self::ASSET_NAMESPACE, 'manifest'), |
|
150 | + array(), |
|
151 | + null, |
|
152 | + true |
|
153 | + ); |
|
154 | + wp_register_script( |
|
155 | + 'eejs-core', |
|
156 | + $this->getJsUrl(self::ASSET_NAMESPACE, 'eejs'), |
|
157 | + array('ee-manifest'), |
|
158 | + null, |
|
159 | + true |
|
160 | + ); |
|
161 | + wp_register_script( |
|
162 | + 'ee-vendor-react', |
|
163 | + $this->getJsUrl(self::ASSET_NAMESPACE, 'reactVendor'), |
|
164 | + array('eejs-core'), |
|
165 | + null, |
|
166 | + true |
|
167 | + ); |
|
168 | + //only run this if WordPress 4.4.0 > is in use. |
|
169 | + if (version_compare($wp_version, '4.4.0', '>')) { |
|
170 | + //js.api |
|
171 | + wp_register_script( |
|
172 | + 'eejs-api', |
|
173 | + EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js', |
|
174 | + array('underscore', 'eejs-core'), |
|
175 | + EVENT_ESPRESSO_VERSION, |
|
176 | + true |
|
177 | + ); |
|
178 | + $this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest'); |
|
179 | + $this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/')); |
|
180 | + } |
|
181 | + if (! is_admin()) { |
|
182 | + $this->loadCoreCss(); |
|
183 | + } |
|
184 | + $this->registerTranslationsForHandles(array('eejs-core')); |
|
185 | + $this->loadCoreJs(); |
|
186 | + $this->loadJqueryValidate(); |
|
187 | + $this->loadAccountingJs(); |
|
188 | + $this->loadQtipJs(); |
|
189 | + $this->registerAdminAssets(); |
|
190 | + } |
|
191 | + |
|
192 | + |
|
193 | + |
|
194 | + /** |
|
195 | + * Call back for the script print in frontend and backend. |
|
196 | + * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point. |
|
197 | + * |
|
198 | + * @since 4.9.31.rc.015 |
|
199 | + */ |
|
200 | + public function enqueueData() |
|
201 | + { |
|
202 | + $this->removeAlreadyRegisteredDataForScriptHandles(); |
|
203 | + wp_add_inline_script( |
|
204 | + 'eejs-core', |
|
205 | + 'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)), |
|
206 | + 'before' |
|
207 | + ); |
|
208 | + wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings); |
|
209 | + $this->localizeAccountingJs(); |
|
210 | + $this->addRegisteredScriptHandlesWithData('eejs-core'); |
|
211 | + $this->addRegisteredScriptHandlesWithData('espresso_core'); |
|
212 | + } |
|
213 | + |
|
214 | + |
|
215 | + |
|
216 | + /** |
|
217 | + * Used to add data to eejs.data object. |
|
218 | + * Note: Overriding existing data is not allowed. |
|
219 | + * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript. |
|
220 | + * If the data you add is something like this: |
|
221 | + * $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) ); |
|
222 | + * It will be exposed in the page source as: |
|
223 | + * eejs.data.my_plugin_data.foo == gar |
|
224 | + * |
|
225 | + * @param string $key Key used to access your data |
|
226 | + * @param string|array $value Value to attach to key |
|
227 | + * @throws InvalidArgumentException |
|
228 | + */ |
|
229 | + public function addData($key, $value) |
|
230 | + { |
|
231 | + if ($this->verifyDataNotExisting($key)) { |
|
232 | + $this->jsdata[$key] = $value; |
|
233 | + } |
|
234 | + } |
|
235 | + |
|
236 | + |
|
237 | + |
|
238 | + /** |
|
239 | + * Similar to addData except this allows for users to push values to an existing key where the values on key are |
|
240 | + * elements in an array. |
|
241 | + * When you use this method, the value you include will be appended to the end of an array on $key. |
|
242 | + * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript |
|
243 | + * object like this, eejs.data.test = [ my_data, |
|
244 | + * ] |
|
245 | + * If there has already been a scalar value attached to the data object given key, then |
|
246 | + * this will throw an exception. |
|
247 | + * |
|
248 | + * @param string $key Key to attach data to. |
|
249 | + * @param string|array $value Value being registered. |
|
250 | + * @throws InvalidArgumentException |
|
251 | + */ |
|
252 | + public function pushData($key, $value) |
|
253 | + { |
|
254 | + if (isset($this->jsdata[$key]) |
|
255 | + && ! is_array($this->jsdata[$key]) |
|
256 | + ) { |
|
257 | + throw new invalidArgumentException( |
|
258 | + sprintf( |
|
259 | + __( |
|
260 | + 'The value for %1$s is already set and it is not an array. The %2$s method can only be used to |
|
261 | 261 | push values to this data element when it is an array.', |
262 | - 'event_espresso' |
|
263 | - ), |
|
264 | - $key, |
|
265 | - __METHOD__ |
|
266 | - ) |
|
267 | - ); |
|
268 | - } |
|
269 | - $this->jsdata[$key][] = $value; |
|
270 | - } |
|
271 | - |
|
272 | - |
|
273 | - |
|
274 | - /** |
|
275 | - * Used to set content used by javascript for a template. |
|
276 | - * Note: Overrides of existing registered templates are not allowed. |
|
277 | - * |
|
278 | - * @param string $template_reference |
|
279 | - * @param string $template_content |
|
280 | - * @throws InvalidArgumentException |
|
281 | - */ |
|
282 | - public function addTemplate($template_reference, $template_content) |
|
283 | - { |
|
284 | - if (! isset($this->jsdata['templates'])) { |
|
285 | - $this->jsdata['templates'] = array(); |
|
286 | - } |
|
287 | - //no overrides allowed. |
|
288 | - if (isset($this->jsdata['templates'][$template_reference])) { |
|
289 | - throw new invalidArgumentException( |
|
290 | - sprintf( |
|
291 | - __( |
|
292 | - 'The %1$s key already exists for the templates array in the js data array. No overrides are allowed.', |
|
293 | - 'event_espresso' |
|
294 | - ), |
|
295 | - $template_reference |
|
296 | - ) |
|
297 | - ); |
|
298 | - } |
|
299 | - $this->jsdata['templates'][$template_reference] = $template_content; |
|
300 | - } |
|
301 | - |
|
302 | - |
|
303 | - |
|
304 | - /** |
|
305 | - * Retrieve the template content already registered for the given reference. |
|
306 | - * |
|
307 | - * @param string $template_reference |
|
308 | - * @return string |
|
309 | - */ |
|
310 | - public function getTemplate($template_reference) |
|
311 | - { |
|
312 | - return isset($this->jsdata['templates'], $this->jsdata['templates'][$template_reference]) |
|
313 | - ? $this->jsdata['templates'][$template_reference] |
|
314 | - : ''; |
|
315 | - } |
|
316 | - |
|
317 | - |
|
318 | - |
|
319 | - /** |
|
320 | - * Retrieve registered data. |
|
321 | - * |
|
322 | - * @param string $key Name of key to attach data to. |
|
323 | - * @return mixed If there is no for the given key, then false is returned. |
|
324 | - */ |
|
325 | - public function getData($key) |
|
326 | - { |
|
327 | - return isset($this->jsdata[$key]) |
|
328 | - ? $this->jsdata[$key] |
|
329 | - : false; |
|
330 | - } |
|
331 | - |
|
332 | - |
|
333 | - /** |
|
334 | - * Get the actual asset path for asset manifests. |
|
335 | - * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned. |
|
336 | - * @param string $namespace The namespace associated with the manifest file hosting the map of chunk_name to actual |
|
337 | - * asset file location. |
|
338 | - * @param string $chunk_name |
|
339 | - * @param string $asset_type |
|
340 | - * @return string |
|
341 | - * @since 4.9.59.p |
|
342 | - */ |
|
343 | - public function getAssetUrl($namespace, $chunk_name, $asset_type) |
|
344 | - { |
|
345 | - $url = isset( |
|
346 | - $this->manifest_data[$namespace][$chunk_name][$asset_type], |
|
347 | - $this->manifest_data[$namespace]['url_base'] |
|
348 | - ) |
|
349 | - ? $this->manifest_data[$namespace]['url_base'] |
|
350 | - . $this->manifest_data[$namespace][$chunk_name][$asset_type] |
|
351 | - : $chunk_name; |
|
352 | - return apply_filters( |
|
353 | - 'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl', |
|
354 | - $url, |
|
355 | - $namespace, |
|
356 | - $chunk_name, |
|
357 | - $asset_type |
|
358 | - ); |
|
359 | - } |
|
360 | - |
|
361 | - |
|
362 | - /** |
|
363 | - * Return the url to a js file for the given namespace and chunk name. |
|
364 | - * |
|
365 | - * @param string $namespace |
|
366 | - * @param string $chunk_name |
|
367 | - * @return string |
|
368 | - */ |
|
369 | - public function getJsUrl($namespace, $chunk_name) |
|
370 | - { |
|
371 | - return $this->getAssetUrl($namespace, $chunk_name, self::ASSET_TYPE_JS); |
|
372 | - } |
|
373 | - |
|
374 | - |
|
375 | - /** |
|
376 | - * Return the url to a css file for the given namespace and chunk name. |
|
377 | - * |
|
378 | - * @param string $namespace |
|
379 | - * @param string $chunk_name |
|
380 | - * @return string |
|
381 | - */ |
|
382 | - public function getCssUrl($namespace, $chunk_name) |
|
383 | - { |
|
384 | - return $this->getAssetUrl($namespace, $chunk_name, self::ASSET_TYPE_CSS); |
|
385 | - } |
|
386 | - |
|
387 | - |
|
388 | - /** |
|
389 | - * Used to register a js/css manifest file with the registered_manifest_files property. |
|
390 | - * |
|
391 | - * @param string $namespace Provided to associate the manifest file with a specific namespace. |
|
392 | - * @param string $url_base The url base for the manifest file location. |
|
393 | - * @param string $manifest_file The absolute path to the manifest file. |
|
394 | - * @throws InvalidArgumentException |
|
395 | - * @throws InvalidFilePathException |
|
396 | - * @since 4.9.59.p |
|
397 | - */ |
|
398 | - public function registerManifestFile($namespace, $url_base, $manifest_file) |
|
399 | - { |
|
400 | - if (isset($this->manifest_data[$namespace])) { |
|
401 | - throw new InvalidArgumentException( |
|
402 | - sprintf( |
|
403 | - esc_html__( |
|
404 | - 'The namespace for this manifest file has already been registered, choose a namespace other than %s', |
|
405 | - 'event_espresso' |
|
406 | - ), |
|
407 | - $namespace |
|
408 | - ) |
|
409 | - ); |
|
410 | - } |
|
411 | - if (filter_var($url_base, FILTER_VALIDATE_URL) === false) { |
|
412 | - if (is_admin()) { |
|
413 | - EE_Error::add_error( |
|
414 | - sprintf( |
|
415 | - esc_html__( |
|
416 | - 'The url given for %1$s assets is invalid. The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant', |
|
417 | - 'event_espresso' |
|
418 | - ), |
|
419 | - 'Event Espresso', |
|
420 | - $url_base, |
|
421 | - 'plugins_url', |
|
422 | - 'WP_PLUGIN_URL' |
|
423 | - ), |
|
424 | - __FILE__, |
|
425 | - __FUNCTION__, |
|
426 | - __LINE__ |
|
427 | - ); |
|
428 | - } |
|
429 | - return; |
|
430 | - } |
|
431 | - $this->manifest_data[$namespace] = $this->decodeManifestFile($manifest_file); |
|
432 | - if (! isset($this->manifest_data[$namespace]['url_base'])) { |
|
433 | - $this->manifest_data[$namespace]['url_base'] = trailingslashit($url_base); |
|
434 | - } |
|
435 | - } |
|
436 | - |
|
437 | - |
|
438 | - |
|
439 | - /** |
|
440 | - * Decodes json from the provided manifest file. |
|
441 | - * |
|
442 | - * @since 4.9.59.p |
|
443 | - * @param string $manifest_file Path to manifest file. |
|
444 | - * @return array |
|
445 | - * @throws InvalidFilePathException |
|
446 | - */ |
|
447 | - private function decodeManifestFile($manifest_file) |
|
448 | - { |
|
449 | - if (! file_exists($manifest_file)) { |
|
450 | - throw new InvalidFilePathException($manifest_file); |
|
451 | - } |
|
452 | - return json_decode(file_get_contents($manifest_file), true); |
|
453 | - } |
|
454 | - |
|
455 | - |
|
456 | - |
|
457 | - /** |
|
458 | - * Verifies whether the given data exists already on the jsdata array. |
|
459 | - * Overriding data is not allowed. |
|
460 | - * |
|
461 | - * @param string $key Index for data. |
|
462 | - * @return bool If valid then return true. |
|
463 | - * @throws InvalidArgumentException if data already exists. |
|
464 | - */ |
|
465 | - protected function verifyDataNotExisting($key) |
|
466 | - { |
|
467 | - if (isset($this->jsdata[$key])) { |
|
468 | - if (is_array($this->jsdata[$key])) { |
|
469 | - throw new InvalidArgumentException( |
|
470 | - sprintf( |
|
471 | - __( |
|
472 | - 'The value for %1$s already exists in the Registry::eejs object. |
|
262 | + 'event_espresso' |
|
263 | + ), |
|
264 | + $key, |
|
265 | + __METHOD__ |
|
266 | + ) |
|
267 | + ); |
|
268 | + } |
|
269 | + $this->jsdata[$key][] = $value; |
|
270 | + } |
|
271 | + |
|
272 | + |
|
273 | + |
|
274 | + /** |
|
275 | + * Used to set content used by javascript for a template. |
|
276 | + * Note: Overrides of existing registered templates are not allowed. |
|
277 | + * |
|
278 | + * @param string $template_reference |
|
279 | + * @param string $template_content |
|
280 | + * @throws InvalidArgumentException |
|
281 | + */ |
|
282 | + public function addTemplate($template_reference, $template_content) |
|
283 | + { |
|
284 | + if (! isset($this->jsdata['templates'])) { |
|
285 | + $this->jsdata['templates'] = array(); |
|
286 | + } |
|
287 | + //no overrides allowed. |
|
288 | + if (isset($this->jsdata['templates'][$template_reference])) { |
|
289 | + throw new invalidArgumentException( |
|
290 | + sprintf( |
|
291 | + __( |
|
292 | + 'The %1$s key already exists for the templates array in the js data array. No overrides are allowed.', |
|
293 | + 'event_espresso' |
|
294 | + ), |
|
295 | + $template_reference |
|
296 | + ) |
|
297 | + ); |
|
298 | + } |
|
299 | + $this->jsdata['templates'][$template_reference] = $template_content; |
|
300 | + } |
|
301 | + |
|
302 | + |
|
303 | + |
|
304 | + /** |
|
305 | + * Retrieve the template content already registered for the given reference. |
|
306 | + * |
|
307 | + * @param string $template_reference |
|
308 | + * @return string |
|
309 | + */ |
|
310 | + public function getTemplate($template_reference) |
|
311 | + { |
|
312 | + return isset($this->jsdata['templates'], $this->jsdata['templates'][$template_reference]) |
|
313 | + ? $this->jsdata['templates'][$template_reference] |
|
314 | + : ''; |
|
315 | + } |
|
316 | + |
|
317 | + |
|
318 | + |
|
319 | + /** |
|
320 | + * Retrieve registered data. |
|
321 | + * |
|
322 | + * @param string $key Name of key to attach data to. |
|
323 | + * @return mixed If there is no for the given key, then false is returned. |
|
324 | + */ |
|
325 | + public function getData($key) |
|
326 | + { |
|
327 | + return isset($this->jsdata[$key]) |
|
328 | + ? $this->jsdata[$key] |
|
329 | + : false; |
|
330 | + } |
|
331 | + |
|
332 | + |
|
333 | + /** |
|
334 | + * Get the actual asset path for asset manifests. |
|
335 | + * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned. |
|
336 | + * @param string $namespace The namespace associated with the manifest file hosting the map of chunk_name to actual |
|
337 | + * asset file location. |
|
338 | + * @param string $chunk_name |
|
339 | + * @param string $asset_type |
|
340 | + * @return string |
|
341 | + * @since 4.9.59.p |
|
342 | + */ |
|
343 | + public function getAssetUrl($namespace, $chunk_name, $asset_type) |
|
344 | + { |
|
345 | + $url = isset( |
|
346 | + $this->manifest_data[$namespace][$chunk_name][$asset_type], |
|
347 | + $this->manifest_data[$namespace]['url_base'] |
|
348 | + ) |
|
349 | + ? $this->manifest_data[$namespace]['url_base'] |
|
350 | + . $this->manifest_data[$namespace][$chunk_name][$asset_type] |
|
351 | + : $chunk_name; |
|
352 | + return apply_filters( |
|
353 | + 'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl', |
|
354 | + $url, |
|
355 | + $namespace, |
|
356 | + $chunk_name, |
|
357 | + $asset_type |
|
358 | + ); |
|
359 | + } |
|
360 | + |
|
361 | + |
|
362 | + /** |
|
363 | + * Return the url to a js file for the given namespace and chunk name. |
|
364 | + * |
|
365 | + * @param string $namespace |
|
366 | + * @param string $chunk_name |
|
367 | + * @return string |
|
368 | + */ |
|
369 | + public function getJsUrl($namespace, $chunk_name) |
|
370 | + { |
|
371 | + return $this->getAssetUrl($namespace, $chunk_name, self::ASSET_TYPE_JS); |
|
372 | + } |
|
373 | + |
|
374 | + |
|
375 | + /** |
|
376 | + * Return the url to a css file for the given namespace and chunk name. |
|
377 | + * |
|
378 | + * @param string $namespace |
|
379 | + * @param string $chunk_name |
|
380 | + * @return string |
|
381 | + */ |
|
382 | + public function getCssUrl($namespace, $chunk_name) |
|
383 | + { |
|
384 | + return $this->getAssetUrl($namespace, $chunk_name, self::ASSET_TYPE_CSS); |
|
385 | + } |
|
386 | + |
|
387 | + |
|
388 | + /** |
|
389 | + * Used to register a js/css manifest file with the registered_manifest_files property. |
|
390 | + * |
|
391 | + * @param string $namespace Provided to associate the manifest file with a specific namespace. |
|
392 | + * @param string $url_base The url base for the manifest file location. |
|
393 | + * @param string $manifest_file The absolute path to the manifest file. |
|
394 | + * @throws InvalidArgumentException |
|
395 | + * @throws InvalidFilePathException |
|
396 | + * @since 4.9.59.p |
|
397 | + */ |
|
398 | + public function registerManifestFile($namespace, $url_base, $manifest_file) |
|
399 | + { |
|
400 | + if (isset($this->manifest_data[$namespace])) { |
|
401 | + throw new InvalidArgumentException( |
|
402 | + sprintf( |
|
403 | + esc_html__( |
|
404 | + 'The namespace for this manifest file has already been registered, choose a namespace other than %s', |
|
405 | + 'event_espresso' |
|
406 | + ), |
|
407 | + $namespace |
|
408 | + ) |
|
409 | + ); |
|
410 | + } |
|
411 | + if (filter_var($url_base, FILTER_VALIDATE_URL) === false) { |
|
412 | + if (is_admin()) { |
|
413 | + EE_Error::add_error( |
|
414 | + sprintf( |
|
415 | + esc_html__( |
|
416 | + 'The url given for %1$s assets is invalid. The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant', |
|
417 | + 'event_espresso' |
|
418 | + ), |
|
419 | + 'Event Espresso', |
|
420 | + $url_base, |
|
421 | + 'plugins_url', |
|
422 | + 'WP_PLUGIN_URL' |
|
423 | + ), |
|
424 | + __FILE__, |
|
425 | + __FUNCTION__, |
|
426 | + __LINE__ |
|
427 | + ); |
|
428 | + } |
|
429 | + return; |
|
430 | + } |
|
431 | + $this->manifest_data[$namespace] = $this->decodeManifestFile($manifest_file); |
|
432 | + if (! isset($this->manifest_data[$namespace]['url_base'])) { |
|
433 | + $this->manifest_data[$namespace]['url_base'] = trailingslashit($url_base); |
|
434 | + } |
|
435 | + } |
|
436 | + |
|
437 | + |
|
438 | + |
|
439 | + /** |
|
440 | + * Decodes json from the provided manifest file. |
|
441 | + * |
|
442 | + * @since 4.9.59.p |
|
443 | + * @param string $manifest_file Path to manifest file. |
|
444 | + * @return array |
|
445 | + * @throws InvalidFilePathException |
|
446 | + */ |
|
447 | + private function decodeManifestFile($manifest_file) |
|
448 | + { |
|
449 | + if (! file_exists($manifest_file)) { |
|
450 | + throw new InvalidFilePathException($manifest_file); |
|
451 | + } |
|
452 | + return json_decode(file_get_contents($manifest_file), true); |
|
453 | + } |
|
454 | + |
|
455 | + |
|
456 | + |
|
457 | + /** |
|
458 | + * Verifies whether the given data exists already on the jsdata array. |
|
459 | + * Overriding data is not allowed. |
|
460 | + * |
|
461 | + * @param string $key Index for data. |
|
462 | + * @return bool If valid then return true. |
|
463 | + * @throws InvalidArgumentException if data already exists. |
|
464 | + */ |
|
465 | + protected function verifyDataNotExisting($key) |
|
466 | + { |
|
467 | + if (isset($this->jsdata[$key])) { |
|
468 | + if (is_array($this->jsdata[$key])) { |
|
469 | + throw new InvalidArgumentException( |
|
470 | + sprintf( |
|
471 | + __( |
|
472 | + 'The value for %1$s already exists in the Registry::eejs object. |
|
473 | 473 | Overrides are not allowed. Since the value of this data is an array, you may want to use the |
474 | 474 | %2$s method to push your value to the array.', |
475 | - 'event_espresso' |
|
476 | - ), |
|
477 | - $key, |
|
478 | - 'pushData()' |
|
479 | - ) |
|
480 | - ); |
|
481 | - } |
|
482 | - throw new InvalidArgumentException( |
|
483 | - sprintf( |
|
484 | - __( |
|
485 | - 'The value for %1$s already exists in the Registry::eejs object. Overrides are not |
|
475 | + 'event_espresso' |
|
476 | + ), |
|
477 | + $key, |
|
478 | + 'pushData()' |
|
479 | + ) |
|
480 | + ); |
|
481 | + } |
|
482 | + throw new InvalidArgumentException( |
|
483 | + sprintf( |
|
484 | + __( |
|
485 | + 'The value for %1$s already exists in the Registry::eejs object. Overrides are not |
|
486 | 486 | allowed. Consider attaching your value to a different key', |
487 | - 'event_espresso' |
|
488 | - ), |
|
489 | - $key |
|
490 | - ) |
|
491 | - ); |
|
492 | - } |
|
493 | - return true; |
|
494 | - } |
|
495 | - |
|
496 | - |
|
497 | - |
|
498 | - /** |
|
499 | - * registers core default stylesheets |
|
500 | - */ |
|
501 | - private function loadCoreCss() |
|
502 | - { |
|
503 | - if ($this->template_config->enable_default_style) { |
|
504 | - $default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css') |
|
505 | - ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css' |
|
506 | - : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css'; |
|
507 | - wp_register_style( |
|
508 | - 'espresso_default', |
|
509 | - $default_stylesheet_path, |
|
510 | - array('dashicons'), |
|
511 | - EVENT_ESPRESSO_VERSION |
|
512 | - ); |
|
513 | - //Load custom style sheet if available |
|
514 | - if ($this->template_config->custom_style_sheet !== null) { |
|
515 | - wp_register_style( |
|
516 | - 'espresso_custom_css', |
|
517 | - EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet, |
|
518 | - array('espresso_default'), |
|
519 | - EVENT_ESPRESSO_VERSION |
|
520 | - ); |
|
521 | - } |
|
522 | - } |
|
523 | - } |
|
524 | - |
|
525 | - |
|
526 | - |
|
527 | - /** |
|
528 | - * registers core default javascript |
|
529 | - */ |
|
530 | - private function loadCoreJs() |
|
531 | - { |
|
532 | - // load core js |
|
533 | - wp_register_script( |
|
534 | - 'espresso_core', |
|
535 | - EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
536 | - array('jquery'), |
|
537 | - EVENT_ESPRESSO_VERSION, |
|
538 | - true |
|
539 | - ); |
|
540 | - } |
|
541 | - |
|
542 | - |
|
543 | - |
|
544 | - /** |
|
545 | - * registers jQuery Validate for form validation |
|
546 | - */ |
|
547 | - private function loadJqueryValidate() |
|
548 | - { |
|
549 | - // register jQuery Validate and additional methods |
|
550 | - wp_register_script( |
|
551 | - 'jquery-validate', |
|
552 | - EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js', |
|
553 | - array('jquery'), |
|
554 | - '1.15.0', |
|
555 | - true |
|
556 | - ); |
|
557 | - wp_register_script( |
|
558 | - 'jquery-validate-extra-methods', |
|
559 | - EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js', |
|
560 | - array('jquery', 'jquery-validate'), |
|
561 | - '1.15.0', |
|
562 | - true |
|
563 | - ); |
|
564 | - } |
|
565 | - |
|
566 | - |
|
567 | - |
|
568 | - /** |
|
569 | - * registers accounting.js for performing client-side calculations |
|
570 | - */ |
|
571 | - private function loadAccountingJs() |
|
572 | - { |
|
573 | - //accounting.js library |
|
574 | - // @link http://josscrowcroft.github.io/accounting.js/ |
|
575 | - wp_register_script( |
|
576 | - 'ee-accounting-core', |
|
577 | - EE_THIRD_PARTY_URL . 'accounting/accounting.js', |
|
578 | - array('underscore'), |
|
579 | - '0.3.2', |
|
580 | - true |
|
581 | - ); |
|
582 | - wp_register_script( |
|
583 | - 'ee-accounting', |
|
584 | - EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js', |
|
585 | - array('ee-accounting-core'), |
|
586 | - EVENT_ESPRESSO_VERSION, |
|
587 | - true |
|
588 | - ); |
|
589 | - } |
|
590 | - |
|
591 | - |
|
592 | - |
|
593 | - /** |
|
594 | - * registers accounting.js for performing client-side calculations |
|
595 | - */ |
|
596 | - private function localizeAccountingJs() |
|
597 | - { |
|
598 | - wp_localize_script( |
|
599 | - 'ee-accounting', |
|
600 | - 'EE_ACCOUNTING_CFG', |
|
601 | - array( |
|
602 | - 'currency' => array( |
|
603 | - 'symbol' => $this->currency_config->sign, |
|
604 | - 'format' => array( |
|
605 | - 'pos' => $this->currency_config->sign_b4 ? '%s%v' : '%v%s', |
|
606 | - 'neg' => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s', |
|
607 | - 'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s', |
|
608 | - ), |
|
609 | - 'decimal' => $this->currency_config->dec_mrk, |
|
610 | - 'thousand' => $this->currency_config->thsnds, |
|
611 | - 'precision' => $this->currency_config->dec_plc, |
|
612 | - ), |
|
613 | - 'number' => array( |
|
614 | - 'precision' => $this->currency_config->dec_plc, |
|
615 | - 'thousand' => $this->currency_config->thsnds, |
|
616 | - 'decimal' => $this->currency_config->dec_mrk, |
|
617 | - ), |
|
618 | - ) |
|
619 | - ); |
|
620 | - $this->addRegisteredScriptHandlesWithData('ee-accounting'); |
|
621 | - } |
|
622 | - |
|
623 | - |
|
624 | - |
|
625 | - /** |
|
626 | - * registers assets for cleaning your ears |
|
627 | - */ |
|
628 | - private function loadQtipJs() |
|
629 | - { |
|
630 | - // qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook, |
|
631 | - // can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' ); |
|
632 | - if (apply_filters('FHEE_load_qtip', false)) { |
|
633 | - EEH_Qtip_Loader::instance()->register_and_enqueue(); |
|
634 | - } |
|
635 | - } |
|
636 | - |
|
637 | - |
|
638 | - /** |
|
639 | - * This is used to set registered script handles that have data. |
|
640 | - * @param string $script_handle |
|
641 | - */ |
|
642 | - private function addRegisteredScriptHandlesWithData($script_handle) |
|
643 | - { |
|
644 | - $this->script_handles_with_data[$script_handle] = $script_handle; |
|
645 | - } |
|
646 | - |
|
647 | - |
|
648 | - /**i |
|
487 | + 'event_espresso' |
|
488 | + ), |
|
489 | + $key |
|
490 | + ) |
|
491 | + ); |
|
492 | + } |
|
493 | + return true; |
|
494 | + } |
|
495 | + |
|
496 | + |
|
497 | + |
|
498 | + /** |
|
499 | + * registers core default stylesheets |
|
500 | + */ |
|
501 | + private function loadCoreCss() |
|
502 | + { |
|
503 | + if ($this->template_config->enable_default_style) { |
|
504 | + $default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css') |
|
505 | + ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css' |
|
506 | + : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css'; |
|
507 | + wp_register_style( |
|
508 | + 'espresso_default', |
|
509 | + $default_stylesheet_path, |
|
510 | + array('dashicons'), |
|
511 | + EVENT_ESPRESSO_VERSION |
|
512 | + ); |
|
513 | + //Load custom style sheet if available |
|
514 | + if ($this->template_config->custom_style_sheet !== null) { |
|
515 | + wp_register_style( |
|
516 | + 'espresso_custom_css', |
|
517 | + EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet, |
|
518 | + array('espresso_default'), |
|
519 | + EVENT_ESPRESSO_VERSION |
|
520 | + ); |
|
521 | + } |
|
522 | + } |
|
523 | + } |
|
524 | + |
|
525 | + |
|
526 | + |
|
527 | + /** |
|
528 | + * registers core default javascript |
|
529 | + */ |
|
530 | + private function loadCoreJs() |
|
531 | + { |
|
532 | + // load core js |
|
533 | + wp_register_script( |
|
534 | + 'espresso_core', |
|
535 | + EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
536 | + array('jquery'), |
|
537 | + EVENT_ESPRESSO_VERSION, |
|
538 | + true |
|
539 | + ); |
|
540 | + } |
|
541 | + |
|
542 | + |
|
543 | + |
|
544 | + /** |
|
545 | + * registers jQuery Validate for form validation |
|
546 | + */ |
|
547 | + private function loadJqueryValidate() |
|
548 | + { |
|
549 | + // register jQuery Validate and additional methods |
|
550 | + wp_register_script( |
|
551 | + 'jquery-validate', |
|
552 | + EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js', |
|
553 | + array('jquery'), |
|
554 | + '1.15.0', |
|
555 | + true |
|
556 | + ); |
|
557 | + wp_register_script( |
|
558 | + 'jquery-validate-extra-methods', |
|
559 | + EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js', |
|
560 | + array('jquery', 'jquery-validate'), |
|
561 | + '1.15.0', |
|
562 | + true |
|
563 | + ); |
|
564 | + } |
|
565 | + |
|
566 | + |
|
567 | + |
|
568 | + /** |
|
569 | + * registers accounting.js for performing client-side calculations |
|
570 | + */ |
|
571 | + private function loadAccountingJs() |
|
572 | + { |
|
573 | + //accounting.js library |
|
574 | + // @link http://josscrowcroft.github.io/accounting.js/ |
|
575 | + wp_register_script( |
|
576 | + 'ee-accounting-core', |
|
577 | + EE_THIRD_PARTY_URL . 'accounting/accounting.js', |
|
578 | + array('underscore'), |
|
579 | + '0.3.2', |
|
580 | + true |
|
581 | + ); |
|
582 | + wp_register_script( |
|
583 | + 'ee-accounting', |
|
584 | + EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js', |
|
585 | + array('ee-accounting-core'), |
|
586 | + EVENT_ESPRESSO_VERSION, |
|
587 | + true |
|
588 | + ); |
|
589 | + } |
|
590 | + |
|
591 | + |
|
592 | + |
|
593 | + /** |
|
594 | + * registers accounting.js for performing client-side calculations |
|
595 | + */ |
|
596 | + private function localizeAccountingJs() |
|
597 | + { |
|
598 | + wp_localize_script( |
|
599 | + 'ee-accounting', |
|
600 | + 'EE_ACCOUNTING_CFG', |
|
601 | + array( |
|
602 | + 'currency' => array( |
|
603 | + 'symbol' => $this->currency_config->sign, |
|
604 | + 'format' => array( |
|
605 | + 'pos' => $this->currency_config->sign_b4 ? '%s%v' : '%v%s', |
|
606 | + 'neg' => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s', |
|
607 | + 'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s', |
|
608 | + ), |
|
609 | + 'decimal' => $this->currency_config->dec_mrk, |
|
610 | + 'thousand' => $this->currency_config->thsnds, |
|
611 | + 'precision' => $this->currency_config->dec_plc, |
|
612 | + ), |
|
613 | + 'number' => array( |
|
614 | + 'precision' => $this->currency_config->dec_plc, |
|
615 | + 'thousand' => $this->currency_config->thsnds, |
|
616 | + 'decimal' => $this->currency_config->dec_mrk, |
|
617 | + ), |
|
618 | + ) |
|
619 | + ); |
|
620 | + $this->addRegisteredScriptHandlesWithData('ee-accounting'); |
|
621 | + } |
|
622 | + |
|
623 | + |
|
624 | + |
|
625 | + /** |
|
626 | + * registers assets for cleaning your ears |
|
627 | + */ |
|
628 | + private function loadQtipJs() |
|
629 | + { |
|
630 | + // qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook, |
|
631 | + // can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' ); |
|
632 | + if (apply_filters('FHEE_load_qtip', false)) { |
|
633 | + EEH_Qtip_Loader::instance()->register_and_enqueue(); |
|
634 | + } |
|
635 | + } |
|
636 | + |
|
637 | + |
|
638 | + /** |
|
639 | + * This is used to set registered script handles that have data. |
|
640 | + * @param string $script_handle |
|
641 | + */ |
|
642 | + private function addRegisteredScriptHandlesWithData($script_handle) |
|
643 | + { |
|
644 | + $this->script_handles_with_data[$script_handle] = $script_handle; |
|
645 | + } |
|
646 | + |
|
647 | + |
|
648 | + /**i |
|
649 | 649 | * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the |
650 | 650 | * Dependency stored in WP_Scripts if its set. |
651 | 651 | */ |
652 | - private function removeAlreadyRegisteredDataForScriptHandles() |
|
653 | - { |
|
654 | - if (empty($this->script_handles_with_data)) { |
|
655 | - return; |
|
656 | - } |
|
657 | - foreach ($this->script_handles_with_data as $script_handle) { |
|
658 | - $this->removeAlreadyRegisteredDataForScriptHandle($script_handle); |
|
659 | - } |
|
660 | - } |
|
661 | - |
|
662 | - |
|
663 | - /** |
|
664 | - * Removes any data dependency registered in WP_Scripts if its set. |
|
665 | - * @param string $script_handle |
|
666 | - */ |
|
667 | - private function removeAlreadyRegisteredDataForScriptHandle($script_handle) |
|
668 | - { |
|
669 | - if (isset($this->script_handles_with_data[$script_handle])) { |
|
670 | - global $wp_scripts; |
|
671 | - $unset_handle = false; |
|
672 | - if ($wp_scripts->get_data($script_handle, 'data')) { |
|
673 | - unset($wp_scripts->registered[$script_handle]->extra['data']); |
|
674 | - $unset_handle = true; |
|
675 | - } |
|
676 | - //deal with inline_scripts |
|
677 | - if ($wp_scripts->get_data($script_handle, 'before')) { |
|
678 | - unset($wp_scripts->registered[$script_handle]->extra['before']); |
|
679 | - $unset_handle = true; |
|
680 | - } |
|
681 | - if ($wp_scripts->get_data($script_handle, 'after')) { |
|
682 | - unset($wp_scripts->registered[$script_handle]->extra['after']); |
|
683 | - } |
|
684 | - if ($unset_handle) { |
|
685 | - unset($this->script_handles_with_data[$script_handle]); |
|
686 | - } |
|
687 | - } |
|
688 | - } |
|
689 | - |
|
690 | - |
|
691 | - /** |
|
692 | - * Registers assets that are used in the WordPress admin. |
|
693 | - */ |
|
694 | - private function registerAdminAssets() |
|
695 | - { |
|
696 | - wp_register_script( |
|
697 | - 'ee-wp-plugins-page', |
|
698 | - $this->getJsUrl(self::ASSET_NAMESPACE, 'wp-plugins-page'), |
|
699 | - array( |
|
700 | - 'jquery', |
|
701 | - 'ee-vendor-react' |
|
702 | - ), |
|
703 | - null, |
|
704 | - true |
|
705 | - ); |
|
706 | - wp_register_style( |
|
707 | - 'ee-wp-plugins-page', |
|
708 | - $this->getCssUrl(self::ASSET_NAMESPACE, 'wp-plugins-page'), |
|
709 | - array(), |
|
710 | - null |
|
711 | - ); |
|
712 | - $this->registerTranslationsForHandles(array('ee-wp-plugins-page')); |
|
713 | - } |
|
714 | - |
|
715 | - |
|
716 | - /** |
|
717 | - * All handles that are registered via the registry that might have translations have their translations registered |
|
718 | - * |
|
719 | - * @param array $handles_to_register |
|
720 | - */ |
|
721 | - private function registerTranslationsForHandles(array $handles_to_register) |
|
722 | - { |
|
723 | - foreach($handles_to_register as $handle) { |
|
724 | - $this->i18n_registry->registerScriptI18n($handle); |
|
725 | - } |
|
726 | - } |
|
652 | + private function removeAlreadyRegisteredDataForScriptHandles() |
|
653 | + { |
|
654 | + if (empty($this->script_handles_with_data)) { |
|
655 | + return; |
|
656 | + } |
|
657 | + foreach ($this->script_handles_with_data as $script_handle) { |
|
658 | + $this->removeAlreadyRegisteredDataForScriptHandle($script_handle); |
|
659 | + } |
|
660 | + } |
|
661 | + |
|
662 | + |
|
663 | + /** |
|
664 | + * Removes any data dependency registered in WP_Scripts if its set. |
|
665 | + * @param string $script_handle |
|
666 | + */ |
|
667 | + private function removeAlreadyRegisteredDataForScriptHandle($script_handle) |
|
668 | + { |
|
669 | + if (isset($this->script_handles_with_data[$script_handle])) { |
|
670 | + global $wp_scripts; |
|
671 | + $unset_handle = false; |
|
672 | + if ($wp_scripts->get_data($script_handle, 'data')) { |
|
673 | + unset($wp_scripts->registered[$script_handle]->extra['data']); |
|
674 | + $unset_handle = true; |
|
675 | + } |
|
676 | + //deal with inline_scripts |
|
677 | + if ($wp_scripts->get_data($script_handle, 'before')) { |
|
678 | + unset($wp_scripts->registered[$script_handle]->extra['before']); |
|
679 | + $unset_handle = true; |
|
680 | + } |
|
681 | + if ($wp_scripts->get_data($script_handle, 'after')) { |
|
682 | + unset($wp_scripts->registered[$script_handle]->extra['after']); |
|
683 | + } |
|
684 | + if ($unset_handle) { |
|
685 | + unset($this->script_handles_with_data[$script_handle]); |
|
686 | + } |
|
687 | + } |
|
688 | + } |
|
689 | + |
|
690 | + |
|
691 | + /** |
|
692 | + * Registers assets that are used in the WordPress admin. |
|
693 | + */ |
|
694 | + private function registerAdminAssets() |
|
695 | + { |
|
696 | + wp_register_script( |
|
697 | + 'ee-wp-plugins-page', |
|
698 | + $this->getJsUrl(self::ASSET_NAMESPACE, 'wp-plugins-page'), |
|
699 | + array( |
|
700 | + 'jquery', |
|
701 | + 'ee-vendor-react' |
|
702 | + ), |
|
703 | + null, |
|
704 | + true |
|
705 | + ); |
|
706 | + wp_register_style( |
|
707 | + 'ee-wp-plugins-page', |
|
708 | + $this->getCssUrl(self::ASSET_NAMESPACE, 'wp-plugins-page'), |
|
709 | + array(), |
|
710 | + null |
|
711 | + ); |
|
712 | + $this->registerTranslationsForHandles(array('ee-wp-plugins-page')); |
|
713 | + } |
|
714 | + |
|
715 | + |
|
716 | + /** |
|
717 | + * All handles that are registered via the registry that might have translations have their translations registered |
|
718 | + * |
|
719 | + * @param array $handles_to_register |
|
720 | + */ |
|
721 | + private function registerTranslationsForHandles(array $handles_to_register) |
|
722 | + { |
|
723 | + foreach($handles_to_register as $handle) { |
|
724 | + $this->i18n_registry->registerScriptI18n($handle); |
|
725 | + } |
|
726 | + } |
|
727 | 727 | } |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | $this->registerManifestFile( |
114 | 114 | self::ASSET_NAMESPACE, |
115 | 115 | $this->domain->distributionAssetsUrl(), |
116 | - $this->domain->distributionAssetsPath() . 'build-manifest.json' |
|
116 | + $this->domain->distributionAssetsPath().'build-manifest.json' |
|
117 | 117 | ); |
118 | 118 | add_action('wp_enqueue_scripts', array($this, 'scripts'), 1); |
119 | 119 | add_action('admin_enqueue_scripts', array($this, 'scripts'), 1); |
@@ -170,7 +170,7 @@ discard block |
||
170 | 170 | //js.api |
171 | 171 | wp_register_script( |
172 | 172 | 'eejs-api', |
173 | - EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js', |
|
173 | + EE_LIBRARIES_URL.'rest_api/assets/js/eejs-api.min.js', |
|
174 | 174 | array('underscore', 'eejs-core'), |
175 | 175 | EVENT_ESPRESSO_VERSION, |
176 | 176 | true |
@@ -178,7 +178,7 @@ discard block |
||
178 | 178 | $this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest'); |
179 | 179 | $this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/')); |
180 | 180 | } |
181 | - if (! is_admin()) { |
|
181 | + if ( ! is_admin()) { |
|
182 | 182 | $this->loadCoreCss(); |
183 | 183 | } |
184 | 184 | $this->registerTranslationsForHandles(array('eejs-core')); |
@@ -202,7 +202,7 @@ discard block |
||
202 | 202 | $this->removeAlreadyRegisteredDataForScriptHandles(); |
203 | 203 | wp_add_inline_script( |
204 | 204 | 'eejs-core', |
205 | - 'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)), |
|
205 | + 'var eejsdata='.wp_json_encode(array('data' => $this->jsdata)), |
|
206 | 206 | 'before' |
207 | 207 | ); |
208 | 208 | wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings); |
@@ -281,7 +281,7 @@ discard block |
||
281 | 281 | */ |
282 | 282 | public function addTemplate($template_reference, $template_content) |
283 | 283 | { |
284 | - if (! isset($this->jsdata['templates'])) { |
|
284 | + if ( ! isset($this->jsdata['templates'])) { |
|
285 | 285 | $this->jsdata['templates'] = array(); |
286 | 286 | } |
287 | 287 | //no overrides allowed. |
@@ -429,7 +429,7 @@ discard block |
||
429 | 429 | return; |
430 | 430 | } |
431 | 431 | $this->manifest_data[$namespace] = $this->decodeManifestFile($manifest_file); |
432 | - if (! isset($this->manifest_data[$namespace]['url_base'])) { |
|
432 | + if ( ! isset($this->manifest_data[$namespace]['url_base'])) { |
|
433 | 433 | $this->manifest_data[$namespace]['url_base'] = trailingslashit($url_base); |
434 | 434 | } |
435 | 435 | } |
@@ -446,7 +446,7 @@ discard block |
||
446 | 446 | */ |
447 | 447 | private function decodeManifestFile($manifest_file) |
448 | 448 | { |
449 | - if (! file_exists($manifest_file)) { |
|
449 | + if ( ! file_exists($manifest_file)) { |
|
450 | 450 | throw new InvalidFilePathException($manifest_file); |
451 | 451 | } |
452 | 452 | return json_decode(file_get_contents($manifest_file), true); |
@@ -501,9 +501,9 @@ discard block |
||
501 | 501 | private function loadCoreCss() |
502 | 502 | { |
503 | 503 | if ($this->template_config->enable_default_style) { |
504 | - $default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css') |
|
504 | + $default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR.'css/style.css') |
|
505 | 505 | ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css' |
506 | - : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css'; |
|
506 | + : EE_GLOBAL_ASSETS_URL.'css/espresso_default.css'; |
|
507 | 507 | wp_register_style( |
508 | 508 | 'espresso_default', |
509 | 509 | $default_stylesheet_path, |
@@ -514,7 +514,7 @@ discard block |
||
514 | 514 | if ($this->template_config->custom_style_sheet !== null) { |
515 | 515 | wp_register_style( |
516 | 516 | 'espresso_custom_css', |
517 | - EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet, |
|
517 | + EVENT_ESPRESSO_UPLOAD_URL.'css/'.$this->template_config->custom_style_sheet, |
|
518 | 518 | array('espresso_default'), |
519 | 519 | EVENT_ESPRESSO_VERSION |
520 | 520 | ); |
@@ -532,7 +532,7 @@ discard block |
||
532 | 532 | // load core js |
533 | 533 | wp_register_script( |
534 | 534 | 'espresso_core', |
535 | - EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
535 | + EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js', |
|
536 | 536 | array('jquery'), |
537 | 537 | EVENT_ESPRESSO_VERSION, |
538 | 538 | true |
@@ -549,14 +549,14 @@ discard block |
||
549 | 549 | // register jQuery Validate and additional methods |
550 | 550 | wp_register_script( |
551 | 551 | 'jquery-validate', |
552 | - EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js', |
|
552 | + EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.min.js', |
|
553 | 553 | array('jquery'), |
554 | 554 | '1.15.0', |
555 | 555 | true |
556 | 556 | ); |
557 | 557 | wp_register_script( |
558 | 558 | 'jquery-validate-extra-methods', |
559 | - EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js', |
|
559 | + EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.additional-methods.min.js', |
|
560 | 560 | array('jquery', 'jquery-validate'), |
561 | 561 | '1.15.0', |
562 | 562 | true |
@@ -574,14 +574,14 @@ discard block |
||
574 | 574 | // @link http://josscrowcroft.github.io/accounting.js/ |
575 | 575 | wp_register_script( |
576 | 576 | 'ee-accounting-core', |
577 | - EE_THIRD_PARTY_URL . 'accounting/accounting.js', |
|
577 | + EE_THIRD_PARTY_URL.'accounting/accounting.js', |
|
578 | 578 | array('underscore'), |
579 | 579 | '0.3.2', |
580 | 580 | true |
581 | 581 | ); |
582 | 582 | wp_register_script( |
583 | 583 | 'ee-accounting', |
584 | - EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js', |
|
584 | + EE_GLOBAL_ASSETS_URL.'scripts/ee-accounting-config.js', |
|
585 | 585 | array('ee-accounting-core'), |
586 | 586 | EVENT_ESPRESSO_VERSION, |
587 | 587 | true |
@@ -720,7 +720,7 @@ discard block |
||
720 | 720 | */ |
721 | 721 | private function registerTranslationsForHandles(array $handles_to_register) |
722 | 722 | { |
723 | - foreach($handles_to_register as $handle) { |
|
723 | + foreach ($handles_to_register as $handle) { |
|
724 | 724 | $this->i18n_registry->registerScriptI18n($handle); |
725 | 725 | } |
726 | 726 | } |
@@ -38,103 +38,103 @@ |
||
38 | 38 | * @since 4.0 |
39 | 39 | */ |
40 | 40 | if (function_exists('espresso_version')) { |
41 | - if (! function_exists('espresso_duplicate_plugin_error')) { |
|
42 | - /** |
|
43 | - * espresso_duplicate_plugin_error |
|
44 | - * displays if more than one version of EE is activated at the same time |
|
45 | - */ |
|
46 | - function espresso_duplicate_plugin_error() |
|
47 | - { |
|
48 | - ?> |
|
41 | + if (! function_exists('espresso_duplicate_plugin_error')) { |
|
42 | + /** |
|
43 | + * espresso_duplicate_plugin_error |
|
44 | + * displays if more than one version of EE is activated at the same time |
|
45 | + */ |
|
46 | + function espresso_duplicate_plugin_error() |
|
47 | + { |
|
48 | + ?> |
|
49 | 49 | <div class="error"> |
50 | 50 | <p> |
51 | 51 | <?php |
52 | - echo esc_html__( |
|
53 | - 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | - 'event_espresso' |
|
55 | - ); ?> |
|
52 | + echo esc_html__( |
|
53 | + 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | + 'event_espresso' |
|
55 | + ); ?> |
|
56 | 56 | </p> |
57 | 57 | </div> |
58 | 58 | <?php |
59 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | - } |
|
61 | - } |
|
62 | - add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
59 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | + } |
|
61 | + } |
|
62 | + add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
63 | 63 | |
64 | 64 | } else { |
65 | - define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
66 | - if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
67 | - /** |
|
68 | - * espresso_minimum_php_version_error |
|
69 | - * @return void |
|
70 | - */ |
|
71 | - function espresso_minimum_php_version_error() |
|
72 | - { |
|
73 | - ?> |
|
65 | + define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
66 | + if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
67 | + /** |
|
68 | + * espresso_minimum_php_version_error |
|
69 | + * @return void |
|
70 | + */ |
|
71 | + function espresso_minimum_php_version_error() |
|
72 | + { |
|
73 | + ?> |
|
74 | 74 | <div class="error"> |
75 | 75 | <p> |
76 | 76 | <?php |
77 | - printf( |
|
78 | - esc_html__( |
|
79 | - 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | - 'event_espresso' |
|
81 | - ), |
|
82 | - EE_MIN_PHP_VER_REQUIRED, |
|
83 | - PHP_VERSION, |
|
84 | - '<br/>', |
|
85 | - '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | - ); |
|
87 | - ?> |
|
77 | + printf( |
|
78 | + esc_html__( |
|
79 | + 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | + 'event_espresso' |
|
81 | + ), |
|
82 | + EE_MIN_PHP_VER_REQUIRED, |
|
83 | + PHP_VERSION, |
|
84 | + '<br/>', |
|
85 | + '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | + ); |
|
87 | + ?> |
|
88 | 88 | </p> |
89 | 89 | </div> |
90 | 90 | <?php |
91 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | - } |
|
91 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | + } |
|
93 | 93 | |
94 | - add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | - } else { |
|
96 | - define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
97 | - /** |
|
98 | - * espresso_version |
|
99 | - * Returns the plugin version |
|
100 | - * |
|
101 | - * @return string |
|
102 | - */ |
|
103 | - function espresso_version() |
|
104 | - { |
|
105 | - return apply_filters('FHEE__espresso__espresso_version', '4.9.62.rc.010'); |
|
106 | - } |
|
94 | + add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | + } else { |
|
96 | + define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
97 | + /** |
|
98 | + * espresso_version |
|
99 | + * Returns the plugin version |
|
100 | + * |
|
101 | + * @return string |
|
102 | + */ |
|
103 | + function espresso_version() |
|
104 | + { |
|
105 | + return apply_filters('FHEE__espresso__espresso_version', '4.9.62.rc.010'); |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * espresso_plugin_activation |
|
110 | - * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
111 | - */ |
|
112 | - function espresso_plugin_activation() |
|
113 | - { |
|
114 | - update_option('ee_espresso_activation', true); |
|
115 | - } |
|
108 | + /** |
|
109 | + * espresso_plugin_activation |
|
110 | + * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
111 | + */ |
|
112 | + function espresso_plugin_activation() |
|
113 | + { |
|
114 | + update_option('ee_espresso_activation', true); |
|
115 | + } |
|
116 | 116 | |
117 | - register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
117 | + register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
118 | 118 | |
119 | - require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
120 | - bootstrap_espresso(); |
|
121 | - } |
|
119 | + require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
120 | + bootstrap_espresso(); |
|
121 | + } |
|
122 | 122 | } |
123 | 123 | if (! function_exists('espresso_deactivate_plugin')) { |
124 | - /** |
|
125 | - * deactivate_plugin |
|
126 | - * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
127 | - * |
|
128 | - * @access public |
|
129 | - * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
130 | - * @return void |
|
131 | - */ |
|
132 | - function espresso_deactivate_plugin($plugin_basename = '') |
|
133 | - { |
|
134 | - if (! function_exists('deactivate_plugins')) { |
|
135 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
136 | - } |
|
137 | - unset($_GET['activate'], $_REQUEST['activate']); |
|
138 | - deactivate_plugins($plugin_basename); |
|
139 | - } |
|
124 | + /** |
|
125 | + * deactivate_plugin |
|
126 | + * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
127 | + * |
|
128 | + * @access public |
|
129 | + * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
130 | + * @return void |
|
131 | + */ |
|
132 | + function espresso_deactivate_plugin($plugin_basename = '') |
|
133 | + { |
|
134 | + if (! function_exists('deactivate_plugins')) { |
|
135 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
136 | + } |
|
137 | + unset($_GET['activate'], $_REQUEST['activate']); |
|
138 | + deactivate_plugins($plugin_basename); |
|
139 | + } |
|
140 | 140 | } |
@@ -19,94 +19,94 @@ |
||
19 | 19 | class ExitModal |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * @var Registry |
|
24 | - */ |
|
25 | - private $assets_registry; |
|
22 | + /** |
|
23 | + * @var Registry |
|
24 | + */ |
|
25 | + private $assets_registry; |
|
26 | 26 | |
27 | - /** |
|
28 | - * ExitModal constructor. |
|
29 | - * |
|
30 | - * @param Registry $assets_registry |
|
31 | - */ |
|
32 | - public function __construct(Registry $assets_registry) |
|
33 | - { |
|
34 | - $this->assets_registry = $assets_registry; |
|
35 | - add_action('in_admin_footer', array($this, 'modalContainer')); |
|
36 | - add_action('admin_enqueue_scripts', array($this, 'enqueues')); |
|
37 | - } |
|
27 | + /** |
|
28 | + * ExitModal constructor. |
|
29 | + * |
|
30 | + * @param Registry $assets_registry |
|
31 | + */ |
|
32 | + public function __construct(Registry $assets_registry) |
|
33 | + { |
|
34 | + $this->assets_registry = $assets_registry; |
|
35 | + add_action('in_admin_footer', array($this, 'modalContainer')); |
|
36 | + add_action('admin_enqueue_scripts', array($this, 'enqueues')); |
|
37 | + } |
|
38 | 38 | |
39 | 39 | |
40 | - /** |
|
41 | - * Callback on in_admin_footer that is used to output the exit modal container. |
|
42 | - */ |
|
43 | - public function modalContainer() |
|
44 | - { |
|
45 | - echo '<div id="ee-exit-survey-modal"></div>'; |
|
46 | - } |
|
40 | + /** |
|
41 | + * Callback on in_admin_footer that is used to output the exit modal container. |
|
42 | + */ |
|
43 | + public function modalContainer() |
|
44 | + { |
|
45 | + echo '<div id="ee-exit-survey-modal"></div>'; |
|
46 | + } |
|
47 | 47 | |
48 | 48 | |
49 | - /** |
|
50 | - * Callback for `admin_enqueue_scripts` to take care of enqueueing scripts and styles specific to the modal. |
|
51 | - * |
|
52 | - * @throws InvalidArgumentException |
|
53 | - */ |
|
54 | - public function enqueues() |
|
55 | - { |
|
56 | - $current_user = new WP_User(get_current_user_id()); |
|
57 | - $this->assets_registry->addData( |
|
58 | - 'exitModali18n', |
|
59 | - array( |
|
60 | - 'introText' => htmlspecialchars( |
|
61 | - __( |
|
62 | - 'Do you have a moment to share why you are deactivating Event Espresso?', |
|
63 | - 'event_espresso' |
|
64 | - ), |
|
65 | - ENT_NOQUOTES |
|
66 | - ), |
|
67 | - 'doSurveyButtonText' => htmlspecialchars( |
|
68 | - __( |
|
69 | - 'Sure I\'ll help', |
|
70 | - 'event_espresso' |
|
71 | - ), |
|
72 | - ENT_NOQUOTES |
|
73 | - ), |
|
74 | - 'skipButtonText' => htmlspecialchars( |
|
75 | - __( |
|
76 | - 'Skip', |
|
77 | - 'event_espresso' |
|
78 | - ), |
|
79 | - ENT_NOQUOTES |
|
80 | - ) |
|
81 | - ) |
|
82 | - ); |
|
83 | - $this->assets_registry->addData( |
|
84 | - 'exitModalInfo', |
|
85 | - array( |
|
86 | - 'firstname' => htmlspecialchars($current_user->user_firstname), |
|
87 | - 'emailaddress' => htmlspecialchars($current_user->user_email), |
|
88 | - 'website' => htmlspecialchars(site_url()), |
|
89 | - 'isModalActive' => $this->isModalActive() |
|
90 | - ) |
|
91 | - ); |
|
49 | + /** |
|
50 | + * Callback for `admin_enqueue_scripts` to take care of enqueueing scripts and styles specific to the modal. |
|
51 | + * |
|
52 | + * @throws InvalidArgumentException |
|
53 | + */ |
|
54 | + public function enqueues() |
|
55 | + { |
|
56 | + $current_user = new WP_User(get_current_user_id()); |
|
57 | + $this->assets_registry->addData( |
|
58 | + 'exitModali18n', |
|
59 | + array( |
|
60 | + 'introText' => htmlspecialchars( |
|
61 | + __( |
|
62 | + 'Do you have a moment to share why you are deactivating Event Espresso?', |
|
63 | + 'event_espresso' |
|
64 | + ), |
|
65 | + ENT_NOQUOTES |
|
66 | + ), |
|
67 | + 'doSurveyButtonText' => htmlspecialchars( |
|
68 | + __( |
|
69 | + 'Sure I\'ll help', |
|
70 | + 'event_espresso' |
|
71 | + ), |
|
72 | + ENT_NOQUOTES |
|
73 | + ), |
|
74 | + 'skipButtonText' => htmlspecialchars( |
|
75 | + __( |
|
76 | + 'Skip', |
|
77 | + 'event_espresso' |
|
78 | + ), |
|
79 | + ENT_NOQUOTES |
|
80 | + ) |
|
81 | + ) |
|
82 | + ); |
|
83 | + $this->assets_registry->addData( |
|
84 | + 'exitModalInfo', |
|
85 | + array( |
|
86 | + 'firstname' => htmlspecialchars($current_user->user_firstname), |
|
87 | + 'emailaddress' => htmlspecialchars($current_user->user_email), |
|
88 | + 'website' => htmlspecialchars(site_url()), |
|
89 | + 'isModalActive' => $this->isModalActive() |
|
90 | + ) |
|
91 | + ); |
|
92 | 92 | |
93 | - wp_enqueue_script('ee-wp-plugins-page'); |
|
94 | - wp_enqueue_style('ee-wp-plugins-page'); |
|
95 | - } |
|
93 | + wp_enqueue_script('ee-wp-plugins-page'); |
|
94 | + wp_enqueue_style('ee-wp-plugins-page'); |
|
95 | + } |
|
96 | 96 | |
97 | 97 | |
98 | - /** |
|
99 | - * Exposes a filter switch for turning off the enqueueing of the modal script. |
|
100 | - * @return bool |
|
101 | - */ |
|
102 | - private function isModalActive() |
|
103 | - { |
|
104 | - return filter_var( |
|
105 | - apply_filters( |
|
106 | - 'FHEE__EventEspresso_core_domain_services_admin_ExitModal__isModalActive', |
|
107 | - true |
|
108 | - ), |
|
109 | - FILTER_VALIDATE_BOOLEAN |
|
110 | - ); |
|
111 | - } |
|
98 | + /** |
|
99 | + * Exposes a filter switch for turning off the enqueueing of the modal script. |
|
100 | + * @return bool |
|
101 | + */ |
|
102 | + private function isModalActive() |
|
103 | + { |
|
104 | + return filter_var( |
|
105 | + apply_filters( |
|
106 | + 'FHEE__EventEspresso_core_domain_services_admin_ExitModal__isModalActive', |
|
107 | + true |
|
108 | + ), |
|
109 | + FILTER_VALIDATE_BOOLEAN |
|
110 | + ); |
|
111 | + } |
|
112 | 112 | } |
@@ -32,1288 +32,1288 @@ |
||
32 | 32 | { |
33 | 33 | |
34 | 34 | |
35 | - /** |
|
36 | - * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation. |
|
37 | - * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc |
|
38 | - */ |
|
39 | - const req_type_normal = 0; |
|
40 | - |
|
41 | - /** |
|
42 | - * Indicates this is a brand new installation of EE so we should install |
|
43 | - * tables and default data etc |
|
44 | - */ |
|
45 | - const req_type_new_activation = 1; |
|
46 | - |
|
47 | - /** |
|
48 | - * we've detected that EE has been reactivated (or EE was activated during maintenance mode, |
|
49 | - * and we just exited maintenance mode). We MUST check the database is setup properly |
|
50 | - * and that default data is setup too |
|
51 | - */ |
|
52 | - const req_type_reactivation = 2; |
|
53 | - |
|
54 | - /** |
|
55 | - * indicates that EE has been upgraded since its previous request. |
|
56 | - * We may have data migration scripts to call and will want to trigger maintenance mode |
|
57 | - */ |
|
58 | - const req_type_upgrade = 3; |
|
59 | - |
|
60 | - /** |
|
61 | - * TODO will detect that EE has been DOWNGRADED. We probably don't want to run in this case... |
|
62 | - */ |
|
63 | - const req_type_downgrade = 4; |
|
64 | - |
|
65 | - /** |
|
66 | - * @deprecated since version 4.6.0.dev.006 |
|
67 | - * Now whenever a new_activation is detected the request type is still just |
|
68 | - * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode |
|
69 | - * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required |
|
70 | - * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode. |
|
71 | - * (Specifically, when the migration manager indicates migrations are finished |
|
72 | - * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called) |
|
73 | - */ |
|
74 | - const req_type_activation_but_not_installed = 5; |
|
75 | - |
|
76 | - /** |
|
77 | - * option prefix for recording the activation history (like core's "espresso_db_update") of addons |
|
78 | - */ |
|
79 | - const addon_activation_history_option_prefix = 'ee_addon_activation_history_'; |
|
80 | - |
|
81 | - |
|
82 | - /** |
|
83 | - * @var EE_System $_instance |
|
84 | - */ |
|
85 | - private static $_instance; |
|
86 | - |
|
87 | - /** |
|
88 | - * @var EE_Registry $registry |
|
89 | - */ |
|
90 | - private $registry; |
|
91 | - |
|
92 | - /** |
|
93 | - * @var LoaderInterface $loader |
|
94 | - */ |
|
95 | - private $loader; |
|
96 | - |
|
97 | - /** |
|
98 | - * @var EE_Capabilities $capabilities |
|
99 | - */ |
|
100 | - private $capabilities; |
|
101 | - |
|
102 | - /** |
|
103 | - * @var RequestInterface $request |
|
104 | - */ |
|
105 | - private $request; |
|
106 | - |
|
107 | - /** |
|
108 | - * @var EE_Maintenance_Mode $maintenance_mode |
|
109 | - */ |
|
110 | - private $maintenance_mode; |
|
111 | - |
|
112 | - /** |
|
113 | - * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*. |
|
114 | - * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request. |
|
115 | - * |
|
116 | - * @var int $_req_type |
|
117 | - */ |
|
118 | - private $_req_type; |
|
119 | - |
|
120 | - /** |
|
121 | - * Whether or not there was a non-micro version change in EE core version during this request |
|
122 | - * |
|
123 | - * @var boolean $_major_version_change |
|
124 | - */ |
|
125 | - private $_major_version_change = false; |
|
126 | - |
|
127 | - /** |
|
128 | - * A Context DTO dedicated solely to identifying the current request type. |
|
129 | - * |
|
130 | - * @var RequestTypeContextCheckerInterface $request_type |
|
131 | - */ |
|
132 | - private $request_type; |
|
133 | - |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * @singleton method used to instantiate class object |
|
138 | - * @param EE_Registry|null $registry |
|
139 | - * @param LoaderInterface|null $loader |
|
140 | - * @param RequestInterface|null $request |
|
141 | - * @param EE_Maintenance_Mode|null $maintenance_mode |
|
142 | - * @return EE_System |
|
143 | - */ |
|
144 | - public static function instance( |
|
145 | - EE_Registry $registry = null, |
|
146 | - LoaderInterface $loader = null, |
|
147 | - RequestInterface $request = null, |
|
148 | - EE_Maintenance_Mode $maintenance_mode = null |
|
149 | - ) { |
|
150 | - // check if class object is instantiated |
|
151 | - if (! self::$_instance instanceof EE_System) { |
|
152 | - self::$_instance = new self($registry, $loader, $request, $maintenance_mode); |
|
153 | - } |
|
154 | - return self::$_instance; |
|
155 | - } |
|
156 | - |
|
157 | - |
|
158 | - |
|
159 | - /** |
|
160 | - * resets the instance and returns it |
|
161 | - * |
|
162 | - * @return EE_System |
|
163 | - */ |
|
164 | - public static function reset() |
|
165 | - { |
|
166 | - self::$_instance->_req_type = null; |
|
167 | - //make sure none of the old hooks are left hanging around |
|
168 | - remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
169 | - //we need to reset the migration manager in order for it to detect DMSs properly |
|
170 | - EE_Data_Migration_Manager::reset(); |
|
171 | - self::instance()->detect_activations_or_upgrades(); |
|
172 | - self::instance()->perform_activations_upgrades_and_migrations(); |
|
173 | - return self::instance(); |
|
174 | - } |
|
175 | - |
|
176 | - |
|
177 | - |
|
178 | - /** |
|
179 | - * sets hooks for running rest of system |
|
180 | - * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
181 | - * starting EE Addons from any other point may lead to problems |
|
182 | - * |
|
183 | - * @param EE_Registry $registry |
|
184 | - * @param LoaderInterface $loader |
|
185 | - * @param RequestInterface $request |
|
186 | - * @param EE_Maintenance_Mode $maintenance_mode |
|
187 | - */ |
|
188 | - private function __construct( |
|
189 | - EE_Registry $registry, |
|
190 | - LoaderInterface $loader, |
|
191 | - RequestInterface $request, |
|
192 | - EE_Maintenance_Mode $maintenance_mode |
|
193 | - ) { |
|
194 | - $this->registry = $registry; |
|
195 | - $this->loader = $loader; |
|
196 | - $this->request = $request; |
|
197 | - $this->maintenance_mode = $maintenance_mode; |
|
198 | - do_action('AHEE__EE_System__construct__begin', $this); |
|
199 | - add_action( |
|
200 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
201 | - array($this, 'loadCapabilities'), |
|
202 | - 5 |
|
203 | - ); |
|
204 | - add_action( |
|
205 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
206 | - array($this, 'loadCommandBus'), |
|
207 | - 7 |
|
208 | - ); |
|
209 | - add_action( |
|
210 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
211 | - array($this, 'loadPluginApi'), |
|
212 | - 9 |
|
213 | - ); |
|
214 | - // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc |
|
215 | - add_action( |
|
216 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
217 | - array($this, 'load_espresso_addons') |
|
218 | - ); |
|
219 | - // when an ee addon is activated, we want to call the core hook(s) again |
|
220 | - // because the newly-activated addon didn't get a chance to run at all |
|
221 | - add_action('activate_plugin', array($this, 'load_espresso_addons'), 1); |
|
222 | - // detect whether install or upgrade |
|
223 | - add_action( |
|
224 | - 'AHEE__EE_Bootstrap__detect_activations_or_upgrades', |
|
225 | - array($this, 'detect_activations_or_upgrades'), |
|
226 | - 3 |
|
227 | - ); |
|
228 | - // load EE_Config, EE_Textdomain, etc |
|
229 | - add_action( |
|
230 | - 'AHEE__EE_Bootstrap__load_core_configuration', |
|
231 | - array($this, 'load_core_configuration'), |
|
232 | - 5 |
|
233 | - ); |
|
234 | - // load EE_Config, EE_Textdomain, etc |
|
235 | - add_action( |
|
236 | - 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets', |
|
237 | - array($this, 'register_shortcodes_modules_and_widgets'), |
|
238 | - 7 |
|
239 | - ); |
|
240 | - // you wanna get going? I wanna get going... let's get going! |
|
241 | - add_action( |
|
242 | - 'AHEE__EE_Bootstrap__brew_espresso', |
|
243 | - array($this, 'brew_espresso'), |
|
244 | - 9 |
|
245 | - ); |
|
246 | - //other housekeeping |
|
247 | - //exclude EE critical pages from wp_list_pages |
|
248 | - add_filter( |
|
249 | - 'wp_list_pages_excludes', |
|
250 | - array($this, 'remove_pages_from_wp_list_pages'), |
|
251 | - 10 |
|
252 | - ); |
|
253 | - // ALL EE Addons should use the following hook point to attach their initial setup too |
|
254 | - // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads |
|
255 | - do_action('AHEE__EE_System__construct__complete', $this); |
|
256 | - } |
|
257 | - |
|
258 | - |
|
259 | - /** |
|
260 | - * load and setup EE_Capabilities |
|
261 | - * |
|
262 | - * @return void |
|
263 | - * @throws EE_Error |
|
264 | - */ |
|
265 | - public function loadCapabilities() |
|
266 | - { |
|
267 | - $this->capabilities = $this->loader->getShared('EE_Capabilities'); |
|
268 | - add_action( |
|
269 | - 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
270 | - function () |
|
271 | - { |
|
272 | - LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager'); |
|
273 | - } |
|
274 | - ); |
|
275 | - } |
|
276 | - |
|
277 | - |
|
278 | - |
|
279 | - /** |
|
280 | - * create and cache the CommandBus, and also add middleware |
|
281 | - * The CapChecker middleware requires the use of EE_Capabilities |
|
282 | - * which is why we need to load the CommandBus after Caps are set up |
|
283 | - * |
|
284 | - * @return void |
|
285 | - * @throws EE_Error |
|
286 | - */ |
|
287 | - public function loadCommandBus() |
|
288 | - { |
|
289 | - $this->loader->getShared( |
|
290 | - 'CommandBusInterface', |
|
291 | - array( |
|
292 | - null, |
|
293 | - apply_filters( |
|
294 | - 'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware', |
|
295 | - array( |
|
296 | - $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'), |
|
297 | - $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'), |
|
298 | - ) |
|
299 | - ), |
|
300 | - ) |
|
301 | - ); |
|
302 | - } |
|
303 | - |
|
304 | - |
|
305 | - |
|
306 | - /** |
|
307 | - * @return void |
|
308 | - * @throws EE_Error |
|
309 | - */ |
|
310 | - public function loadPluginApi() |
|
311 | - { |
|
312 | - // set autoloaders for all of the classes implementing EEI_Plugin_API |
|
313 | - // which provide helpers for EE plugin authors to more easily register certain components with EE. |
|
314 | - EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api'); |
|
315 | - $this->loader->getShared('EE_Request_Handler'); |
|
316 | - } |
|
317 | - |
|
318 | - |
|
319 | - /** |
|
320 | - * @param string $addon_name |
|
321 | - * @param string $version_constant |
|
322 | - * @param string $min_version_required |
|
323 | - * @param string $load_callback |
|
324 | - * @param string $plugin_file_constant |
|
325 | - * @return void |
|
326 | - */ |
|
327 | - private function deactivateIncompatibleAddon( |
|
328 | - $addon_name, |
|
329 | - $version_constant, |
|
330 | - $min_version_required, |
|
331 | - $load_callback, |
|
332 | - $plugin_file_constant |
|
333 | - ) { |
|
334 | - if (! defined($version_constant)) { |
|
335 | - return; |
|
336 | - } |
|
337 | - $addon_version = constant($version_constant); |
|
338 | - if ($addon_version && version_compare($addon_version, $min_version_required, '<')) { |
|
339 | - remove_action('AHEE__EE_System__load_espresso_addons', $load_callback); |
|
340 | - if (! function_exists('deactivate_plugins')) { |
|
341 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
342 | - } |
|
343 | - deactivate_plugins(plugin_basename(constant($plugin_file_constant))); |
|
344 | - unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']); |
|
345 | - EE_Error::add_error( |
|
346 | - sprintf( |
|
347 | - esc_html__( |
|
348 | - 'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.', |
|
349 | - 'event_espresso' |
|
350 | - ), |
|
351 | - $addon_name, |
|
352 | - $min_version_required |
|
353 | - ), |
|
354 | - __FILE__, __FUNCTION__ . "({$addon_name})", __LINE__ |
|
355 | - ); |
|
356 | - EE_Error::get_notices(false, true); |
|
357 | - } |
|
358 | - } |
|
359 | - |
|
360 | - |
|
361 | - /** |
|
362 | - * load_espresso_addons |
|
363 | - * allow addons to load first so that they can set hooks for running DMS's, etc |
|
364 | - * this is hooked into both: |
|
365 | - * 'AHEE__EE_Bootstrap__load_core_configuration' |
|
366 | - * which runs during the WP 'plugins_loaded' action at priority 5 |
|
367 | - * and the WP 'activate_plugin' hook point |
|
368 | - * |
|
369 | - * @access public |
|
370 | - * @return void |
|
371 | - */ |
|
372 | - public function load_espresso_addons() |
|
373 | - { |
|
374 | - $this->deactivateIncompatibleAddon( |
|
375 | - 'Wait Lists', |
|
376 | - 'EE_WAIT_LISTS_VERSION', |
|
377 | - '1.0.0.beta.074', |
|
378 | - 'load_espresso_wait_lists', |
|
379 | - 'EE_WAIT_LISTS_PLUGIN_FILE' |
|
380 | - ); |
|
381 | - $this->deactivateIncompatibleAddon( |
|
382 | - 'Automated Upcoming Event Notifications', |
|
383 | - 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION', |
|
384 | - '1.0.0.beta.091', |
|
385 | - 'load_espresso_automated_upcoming_event_notification', |
|
386 | - 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE' |
|
387 | - ); |
|
388 | - do_action('AHEE__EE_System__load_espresso_addons'); |
|
389 | - //if the WP API basic auth plugin isn't already loaded, load it now. |
|
390 | - //We want it for mobile apps. Just include the entire plugin |
|
391 | - //also, don't load the basic auth when a plugin is getting activated, because |
|
392 | - //it could be the basic auth plugin, and it doesn't check if its methods are already defined |
|
393 | - //and causes a fatal error |
|
394 | - if ( |
|
395 | - $this->request->getRequestParam('activate') !== 'true' |
|
396 | - && ! function_exists('json_basic_auth_handler') |
|
397 | - && ! function_exists('json_basic_auth_error') |
|
398 | - && ! in_array( |
|
399 | - $this->request->getRequestParam('action'), |
|
400 | - array('activate', 'activate-selected'), |
|
401 | - true |
|
402 | - ) |
|
403 | - ) { |
|
404 | - include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php'; |
|
405 | - } |
|
406 | - do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
407 | - } |
|
408 | - |
|
409 | - |
|
410 | - |
|
411 | - /** |
|
412 | - * detect_activations_or_upgrades |
|
413 | - * Checks for activation or upgrade of core first; |
|
414 | - * then also checks if any registered addons have been activated or upgraded |
|
415 | - * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
416 | - * which runs during the WP 'plugins_loaded' action at priority 3 |
|
417 | - * |
|
418 | - * @access public |
|
419 | - * @return void |
|
420 | - */ |
|
421 | - public function detect_activations_or_upgrades() |
|
422 | - { |
|
423 | - //first off: let's make sure to handle core |
|
424 | - $this->detect_if_activation_or_upgrade(); |
|
425 | - foreach ($this->registry->addons as $addon) { |
|
426 | - if ($addon instanceof EE_Addon) { |
|
427 | - //detect teh request type for that addon |
|
428 | - $addon->detect_activation_or_upgrade(); |
|
429 | - } |
|
430 | - } |
|
431 | - } |
|
432 | - |
|
433 | - |
|
434 | - |
|
435 | - /** |
|
436 | - * detect_if_activation_or_upgrade |
|
437 | - * Takes care of detecting whether this is a brand new install or code upgrade, |
|
438 | - * and either setting up the DB or setting up maintenance mode etc. |
|
439 | - * |
|
440 | - * @access public |
|
441 | - * @return void |
|
442 | - */ |
|
443 | - public function detect_if_activation_or_upgrade() |
|
444 | - { |
|
445 | - do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
446 | - // check if db has been updated, or if its a brand-new installation |
|
447 | - $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
448 | - $request_type = $this->detect_req_type($espresso_db_update); |
|
449 | - //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
450 | - switch ($request_type) { |
|
451 | - case EE_System::req_type_new_activation: |
|
452 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
453 | - $this->_handle_core_version_change($espresso_db_update); |
|
454 | - break; |
|
455 | - case EE_System::req_type_reactivation: |
|
456 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
457 | - $this->_handle_core_version_change($espresso_db_update); |
|
458 | - break; |
|
459 | - case EE_System::req_type_upgrade: |
|
460 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
461 | - //migrations may be required now that we've upgraded |
|
462 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
463 | - $this->_handle_core_version_change($espresso_db_update); |
|
464 | - // echo "done upgrade";die; |
|
465 | - break; |
|
466 | - case EE_System::req_type_downgrade: |
|
467 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
468 | - //its possible migrations are no longer required |
|
469 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
470 | - $this->_handle_core_version_change($espresso_db_update); |
|
471 | - break; |
|
472 | - case EE_System::req_type_normal: |
|
473 | - default: |
|
474 | - break; |
|
475 | - } |
|
476 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
477 | - } |
|
478 | - |
|
479 | - |
|
480 | - |
|
481 | - /** |
|
482 | - * Updates the list of installed versions and sets hooks for |
|
483 | - * initializing the database later during the request |
|
484 | - * |
|
485 | - * @param array $espresso_db_update |
|
486 | - */ |
|
487 | - private function _handle_core_version_change($espresso_db_update) |
|
488 | - { |
|
489 | - $this->update_list_of_installed_versions($espresso_db_update); |
|
490 | - //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
491 | - add_action( |
|
492 | - 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
493 | - array($this, 'initialize_db_if_no_migrations_required') |
|
494 | - ); |
|
495 | - } |
|
496 | - |
|
497 | - |
|
498 | - |
|
499 | - /** |
|
500 | - * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
501 | - * information about what versions of EE have been installed and activated, |
|
502 | - * NOT necessarily the state of the database |
|
503 | - * |
|
504 | - * @param mixed $espresso_db_update the value of the WordPress option. |
|
505 | - * If not supplied, fetches it from the options table |
|
506 | - * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
507 | - */ |
|
508 | - private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
509 | - { |
|
510 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
511 | - if (! $espresso_db_update) { |
|
512 | - $espresso_db_update = get_option('espresso_db_update'); |
|
513 | - } |
|
514 | - // check that option is an array |
|
515 | - if (! is_array($espresso_db_update)) { |
|
516 | - // if option is FALSE, then it never existed |
|
517 | - if ($espresso_db_update === false) { |
|
518 | - // make $espresso_db_update an array and save option with autoload OFF |
|
519 | - $espresso_db_update = array(); |
|
520 | - add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
521 | - } else { |
|
522 | - // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
523 | - $espresso_db_update = array($espresso_db_update => array()); |
|
524 | - update_option('espresso_db_update', $espresso_db_update); |
|
525 | - } |
|
526 | - } else { |
|
527 | - $corrected_db_update = array(); |
|
528 | - //if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
529 | - foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
530 | - if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
531 | - //the key is an int, and the value IS NOT an array |
|
532 | - //so it must be numerically-indexed, where values are versions installed... |
|
533 | - //fix it! |
|
534 | - $version_string = $should_be_array; |
|
535 | - $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
536 | - } else { |
|
537 | - //ok it checks out |
|
538 | - $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
539 | - } |
|
540 | - } |
|
541 | - $espresso_db_update = $corrected_db_update; |
|
542 | - update_option('espresso_db_update', $espresso_db_update); |
|
543 | - } |
|
544 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
545 | - return $espresso_db_update; |
|
546 | - } |
|
547 | - |
|
548 | - |
|
549 | - |
|
550 | - /** |
|
551 | - * Does the traditional work of setting up the plugin's database and adding default data. |
|
552 | - * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
553 | - * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
554 | - * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
555 | - * so that it will be done when migrations are finished |
|
556 | - * |
|
557 | - * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
558 | - * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
559 | - * This is a resource-intensive job |
|
560 | - * so we prefer to only do it when necessary |
|
561 | - * @return void |
|
562 | - * @throws EE_Error |
|
563 | - */ |
|
564 | - public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
565 | - { |
|
566 | - $request_type = $this->detect_req_type(); |
|
567 | - //only initialize system if we're not in maintenance mode. |
|
568 | - if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
569 | - update_option('ee_flush_rewrite_rules', true); |
|
570 | - if ($verify_schema) { |
|
571 | - EEH_Activation::initialize_db_and_folders(); |
|
572 | - } |
|
573 | - EEH_Activation::initialize_db_content(); |
|
574 | - EEH_Activation::system_initialization(); |
|
575 | - if ($initialize_addons_too) { |
|
576 | - $this->initialize_addons(); |
|
577 | - } |
|
578 | - } else { |
|
579 | - EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
580 | - } |
|
581 | - if ($request_type === EE_System::req_type_new_activation |
|
582 | - || $request_type === EE_System::req_type_reactivation |
|
583 | - || ( |
|
584 | - $request_type === EE_System::req_type_upgrade |
|
585 | - && $this->is_major_version_change() |
|
586 | - ) |
|
587 | - ) { |
|
588 | - add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
589 | - } |
|
590 | - } |
|
591 | - |
|
592 | - |
|
593 | - |
|
594 | - /** |
|
595 | - * Initializes the db for all registered addons |
|
596 | - * |
|
597 | - * @throws EE_Error |
|
598 | - */ |
|
599 | - public function initialize_addons() |
|
600 | - { |
|
601 | - //foreach registered addon, make sure its db is up-to-date too |
|
602 | - foreach ($this->registry->addons as $addon) { |
|
603 | - if ($addon instanceof EE_Addon) { |
|
604 | - $addon->initialize_db_if_no_migrations_required(); |
|
605 | - } |
|
606 | - } |
|
607 | - } |
|
608 | - |
|
609 | - |
|
610 | - |
|
611 | - /** |
|
612 | - * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
613 | - * |
|
614 | - * @param array $version_history |
|
615 | - * @param string $current_version_to_add version to be added to the version history |
|
616 | - * @return boolean success as to whether or not this option was changed |
|
617 | - */ |
|
618 | - public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
619 | - { |
|
620 | - if (! $version_history) { |
|
621 | - $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
622 | - } |
|
623 | - if ($current_version_to_add === null) { |
|
624 | - $current_version_to_add = espresso_version(); |
|
625 | - } |
|
626 | - $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
627 | - // re-save |
|
628 | - return update_option('espresso_db_update', $version_history); |
|
629 | - } |
|
630 | - |
|
631 | - |
|
632 | - |
|
633 | - /** |
|
634 | - * Detects if the current version indicated in the has existed in the list of |
|
635 | - * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
636 | - * |
|
637 | - * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
638 | - * If not supplied, fetches it from the options table. |
|
639 | - * Also, caches its result so later parts of the code can also know whether |
|
640 | - * there's been an update or not. This way we can add the current version to |
|
641 | - * espresso_db_update, but still know if this is a new install or not |
|
642 | - * @return int one of the constants on EE_System::req_type_ |
|
643 | - */ |
|
644 | - public function detect_req_type($espresso_db_update = null) |
|
645 | - { |
|
646 | - if ($this->_req_type === null) { |
|
647 | - $espresso_db_update = ! empty($espresso_db_update) |
|
648 | - ? $espresso_db_update |
|
649 | - : $this->fix_espresso_db_upgrade_option(); |
|
650 | - $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
651 | - $espresso_db_update, |
|
652 | - 'ee_espresso_activation', espresso_version() |
|
653 | - ); |
|
654 | - $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
655 | - $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
656 | - } |
|
657 | - return $this->_req_type; |
|
658 | - } |
|
659 | - |
|
660 | - |
|
661 | - |
|
662 | - /** |
|
663 | - * Returns whether or not there was a non-micro version change (ie, change in either |
|
664 | - * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
665 | - * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
666 | - * |
|
667 | - * @param $activation_history |
|
668 | - * @return bool |
|
669 | - */ |
|
670 | - private function _detect_major_version_change($activation_history) |
|
671 | - { |
|
672 | - $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
673 | - $previous_version_parts = explode('.', $previous_version); |
|
674 | - $current_version_parts = explode('.', espresso_version()); |
|
675 | - return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
676 | - && ($previous_version_parts[0] !== $current_version_parts[0] |
|
677 | - || $previous_version_parts[1] !== $current_version_parts[1] |
|
678 | - ); |
|
679 | - } |
|
680 | - |
|
681 | - |
|
682 | - |
|
683 | - /** |
|
684 | - * Returns true if either the major or minor version of EE changed during this request. |
|
685 | - * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
686 | - * |
|
687 | - * @return bool |
|
688 | - */ |
|
689 | - public function is_major_version_change() |
|
690 | - { |
|
691 | - return $this->_major_version_change; |
|
692 | - } |
|
693 | - |
|
694 | - |
|
695 | - |
|
696 | - /** |
|
697 | - * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
698 | - * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
699 | - * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
700 | - * just activated to (for core that will always be espresso_version()) |
|
701 | - * |
|
702 | - * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
703 | - * ee plugin. for core that's 'espresso_db_update' |
|
704 | - * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
705 | - * indicate that this plugin was just activated |
|
706 | - * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
707 | - * espresso_version()) |
|
708 | - * @return int one of the constants on EE_System::req_type_* |
|
709 | - */ |
|
710 | - public static function detect_req_type_given_activation_history( |
|
711 | - $activation_history_for_addon, |
|
712 | - $activation_indicator_option_name, |
|
713 | - $version_to_upgrade_to |
|
714 | - ) { |
|
715 | - $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
716 | - if ($activation_history_for_addon) { |
|
717 | - //it exists, so this isn't a completely new install |
|
718 | - //check if this version already in that list of previously installed versions |
|
719 | - if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
720 | - //it a version we haven't seen before |
|
721 | - if ($version_is_higher === 1) { |
|
722 | - $req_type = EE_System::req_type_upgrade; |
|
723 | - } else { |
|
724 | - $req_type = EE_System::req_type_downgrade; |
|
725 | - } |
|
726 | - delete_option($activation_indicator_option_name); |
|
727 | - } else { |
|
728 | - // its not an update. maybe a reactivation? |
|
729 | - if (get_option($activation_indicator_option_name, false)) { |
|
730 | - if ($version_is_higher === -1) { |
|
731 | - $req_type = EE_System::req_type_downgrade; |
|
732 | - } elseif ($version_is_higher === 0) { |
|
733 | - //we've seen this version before, but it's an activation. must be a reactivation |
|
734 | - $req_type = EE_System::req_type_reactivation; |
|
735 | - } else {//$version_is_higher === 1 |
|
736 | - $req_type = EE_System::req_type_upgrade; |
|
737 | - } |
|
738 | - delete_option($activation_indicator_option_name); |
|
739 | - } else { |
|
740 | - //we've seen this version before and the activation indicate doesn't show it was just activated |
|
741 | - if ($version_is_higher === -1) { |
|
742 | - $req_type = EE_System::req_type_downgrade; |
|
743 | - } elseif ($version_is_higher === 0) { |
|
744 | - //we've seen this version before and it's not an activation. its normal request |
|
745 | - $req_type = EE_System::req_type_normal; |
|
746 | - } else {//$version_is_higher === 1 |
|
747 | - $req_type = EE_System::req_type_upgrade; |
|
748 | - } |
|
749 | - } |
|
750 | - } |
|
751 | - } else { |
|
752 | - //brand new install |
|
753 | - $req_type = EE_System::req_type_new_activation; |
|
754 | - delete_option($activation_indicator_option_name); |
|
755 | - } |
|
756 | - return $req_type; |
|
757 | - } |
|
758 | - |
|
759 | - |
|
760 | - |
|
761 | - /** |
|
762 | - * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
763 | - * the $activation_history_for_addon |
|
764 | - * |
|
765 | - * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
766 | - * sometimes containing 'unknown-date' |
|
767 | - * @param string $version_to_upgrade_to (current version) |
|
768 | - * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
769 | - * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
770 | - * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
771 | - * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
772 | - */ |
|
773 | - private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
774 | - { |
|
775 | - //find the most recently-activated version |
|
776 | - $most_recently_active_version = |
|
777 | - EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
778 | - return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
779 | - } |
|
780 | - |
|
781 | - |
|
782 | - |
|
783 | - /** |
|
784 | - * Gets the most recently active version listed in the activation history, |
|
785 | - * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
786 | - * |
|
787 | - * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
788 | - * sometimes containing 'unknown-date' |
|
789 | - * @return string |
|
790 | - */ |
|
791 | - private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
792 | - { |
|
793 | - $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
794 | - $most_recently_active_version = '0.0.0.dev.000'; |
|
795 | - if (is_array($activation_history)) { |
|
796 | - foreach ($activation_history as $version => $times_activated) { |
|
797 | - //check there is a record of when this version was activated. Otherwise, |
|
798 | - //mark it as unknown |
|
799 | - if (! $times_activated) { |
|
800 | - $times_activated = array('unknown-date'); |
|
801 | - } |
|
802 | - if (is_string($times_activated)) { |
|
803 | - $times_activated = array($times_activated); |
|
804 | - } |
|
805 | - foreach ($times_activated as $an_activation) { |
|
806 | - if ($an_activation !== 'unknown-date' |
|
807 | - && $an_activation |
|
808 | - > $most_recently_active_version_activation) { |
|
809 | - $most_recently_active_version = $version; |
|
810 | - $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
811 | - ? '1970-01-01 00:00:00' |
|
812 | - : $an_activation; |
|
813 | - } |
|
814 | - } |
|
815 | - } |
|
816 | - } |
|
817 | - return $most_recently_active_version; |
|
818 | - } |
|
819 | - |
|
820 | - |
|
821 | - |
|
822 | - /** |
|
823 | - * This redirects to the about EE page after activation |
|
824 | - * |
|
825 | - * @return void |
|
826 | - */ |
|
827 | - public function redirect_to_about_ee() |
|
828 | - { |
|
829 | - $notices = EE_Error::get_notices(false); |
|
830 | - //if current user is an admin and it's not an ajax or rest request |
|
831 | - if ( |
|
832 | - ! isset($notices['errors']) |
|
833 | - && $this->request->isAdmin() |
|
834 | - && apply_filters( |
|
835 | - 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
836 | - $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
837 | - ) |
|
838 | - ) { |
|
839 | - $query_params = array('page' => 'espresso_about'); |
|
840 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
841 | - $query_params['new_activation'] = true; |
|
842 | - } |
|
843 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
844 | - $query_params['reactivation'] = true; |
|
845 | - } |
|
846 | - $url = add_query_arg($query_params, admin_url('admin.php')); |
|
847 | - wp_safe_redirect($url); |
|
848 | - exit(); |
|
849 | - } |
|
850 | - } |
|
851 | - |
|
852 | - |
|
853 | - |
|
854 | - /** |
|
855 | - * load_core_configuration |
|
856 | - * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
857 | - * which runs during the WP 'plugins_loaded' action at priority 5 |
|
858 | - * |
|
859 | - * @return void |
|
860 | - * @throws ReflectionException |
|
861 | - */ |
|
862 | - public function load_core_configuration() |
|
863 | - { |
|
864 | - do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
865 | - $this->loader->getShared('EE_Load_Textdomain'); |
|
866 | - //load textdomain |
|
867 | - EE_Load_Textdomain::load_textdomain(); |
|
868 | - // load and setup EE_Config and EE_Network_Config |
|
869 | - $config = $this->loader->getShared('EE_Config'); |
|
870 | - $this->loader->getShared('EE_Network_Config'); |
|
871 | - // setup autoloaders |
|
872 | - // enable logging? |
|
873 | - if ($config->admin->use_full_logging) { |
|
874 | - $this->loader->getShared('EE_Log'); |
|
875 | - } |
|
876 | - // check for activation errors |
|
877 | - $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
878 | - if ($activation_errors) { |
|
879 | - EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
880 | - update_option('ee_plugin_activation_errors', false); |
|
881 | - } |
|
882 | - // get model names |
|
883 | - $this->_parse_model_names(); |
|
884 | - //load caf stuff a chance to play during the activation process too. |
|
885 | - $this->_maybe_brew_regular(); |
|
886 | - do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
887 | - } |
|
888 | - |
|
889 | - |
|
890 | - |
|
891 | - /** |
|
892 | - * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
893 | - * |
|
894 | - * @return void |
|
895 | - * @throws ReflectionException |
|
896 | - */ |
|
897 | - private function _parse_model_names() |
|
898 | - { |
|
899 | - //get all the files in the EE_MODELS folder that end in .model.php |
|
900 | - $models = glob(EE_MODELS . '*.model.php'); |
|
901 | - $model_names = array(); |
|
902 | - $non_abstract_db_models = array(); |
|
903 | - foreach ($models as $model) { |
|
904 | - // get model classname |
|
905 | - $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
906 | - $short_name = str_replace('EEM_', '', $classname); |
|
907 | - $reflectionClass = new ReflectionClass($classname); |
|
908 | - if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
909 | - $non_abstract_db_models[ $short_name ] = $classname; |
|
910 | - } |
|
911 | - $model_names[ $short_name ] = $classname; |
|
912 | - } |
|
913 | - $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
914 | - $this->registry->non_abstract_db_models = apply_filters( |
|
915 | - 'FHEE__EE_System__parse_implemented_model_names', |
|
916 | - $non_abstract_db_models |
|
917 | - ); |
|
918 | - } |
|
919 | - |
|
920 | - |
|
921 | - /** |
|
922 | - * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
923 | - * that need to be setup before our EE_System launches. |
|
924 | - * |
|
925 | - * @return void |
|
926 | - * @throws DomainException |
|
927 | - * @throws InvalidArgumentException |
|
928 | - * @throws InvalidDataTypeException |
|
929 | - * @throws InvalidInterfaceException |
|
930 | - * @throws InvalidClassException |
|
931 | - * @throws InvalidFilePathException |
|
932 | - */ |
|
933 | - private function _maybe_brew_regular() |
|
934 | - { |
|
935 | - /** @var Domain $domain */ |
|
936 | - $domain = DomainFactory::getShared( |
|
937 | - new FullyQualifiedName( |
|
938 | - 'EventEspresso\core\domain\Domain' |
|
939 | - ), |
|
940 | - array( |
|
941 | - new FilePath(EVENT_ESPRESSO_MAIN_FILE), |
|
942 | - Version::fromString(espresso_version()) |
|
943 | - ) |
|
944 | - ); |
|
945 | - if ($domain->isCaffeinated()) { |
|
946 | - require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
947 | - } |
|
948 | - } |
|
949 | - |
|
950 | - |
|
951 | - |
|
952 | - /** |
|
953 | - * register_shortcodes_modules_and_widgets |
|
954 | - * generate lists of shortcodes and modules, then verify paths and classes |
|
955 | - * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
956 | - * which runs during the WP 'plugins_loaded' action at priority 7 |
|
957 | - * |
|
958 | - * @access public |
|
959 | - * @return void |
|
960 | - * @throws Exception |
|
961 | - */ |
|
962 | - public function register_shortcodes_modules_and_widgets() |
|
963 | - { |
|
964 | - try { |
|
965 | - // load, register, and add shortcodes the new way |
|
966 | - if ($this->request->isFrontend() || $this->request->isIframe()) { |
|
967 | - $this->loader->getShared( |
|
968 | - 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
969 | - array( |
|
970 | - // and the old way, but we'll put it under control of the new system |
|
971 | - EE_Config::getLegacyShortcodesManager(), |
|
972 | - ) |
|
973 | - ); |
|
974 | - } |
|
975 | - if (function_exists('register_block_type')) { |
|
976 | - $editor_block_collection = $this->loader->getShared( |
|
977 | - 'EventEspresso\core\domain\entities\editor\EditorBlockCollection' |
|
978 | - ); |
|
979 | - // or the even newer newer new way |
|
980 | - if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAdmin()) { |
|
981 | - $this->loader->getShared( |
|
982 | - 'EventEspresso\core\services\editor\EditorBlockRegistrationManager', |
|
983 | - array($editor_block_collection, $this->request) |
|
984 | - ); |
|
985 | - } |
|
986 | - } |
|
987 | - } catch (Exception $exception) { |
|
988 | - new ExceptionStackTraceDisplay($exception); |
|
989 | - } |
|
990 | - do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
991 | - // check for addons using old hook point |
|
992 | - if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
993 | - $this->_incompatible_addon_error(); |
|
994 | - } |
|
995 | - } |
|
996 | - |
|
997 | - |
|
998 | - |
|
999 | - /** |
|
1000 | - * _incompatible_addon_error |
|
1001 | - * |
|
1002 | - * @access public |
|
1003 | - * @return void |
|
1004 | - */ |
|
1005 | - private function _incompatible_addon_error() |
|
1006 | - { |
|
1007 | - // get array of classes hooking into here |
|
1008 | - $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
1009 | - 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
1010 | - ); |
|
1011 | - if (! empty($class_names)) { |
|
1012 | - $msg = __( |
|
1013 | - 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
1014 | - 'event_espresso' |
|
1015 | - ); |
|
1016 | - $msg .= '<ul>'; |
|
1017 | - foreach ($class_names as $class_name) { |
|
1018 | - $msg .= '<li><b>Event Espresso - ' . str_replace( |
|
1019 | - array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '', |
|
1020 | - $class_name |
|
1021 | - ) . '</b></li>'; |
|
1022 | - } |
|
1023 | - $msg .= '</ul>'; |
|
1024 | - $msg .= __( |
|
1025 | - 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
1026 | - 'event_espresso' |
|
1027 | - ); |
|
1028 | - // save list of incompatible addons to wp-options for later use |
|
1029 | - add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
1030 | - if (is_admin()) { |
|
1031 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1032 | - } |
|
1033 | - } |
|
1034 | - } |
|
1035 | - |
|
1036 | - |
|
1037 | - |
|
1038 | - /** |
|
1039 | - * brew_espresso |
|
1040 | - * begins the process of setting hooks for initializing EE in the correct order |
|
1041 | - * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
1042 | - * which runs during the WP 'plugins_loaded' action at priority 9 |
|
1043 | - * |
|
1044 | - * @return void |
|
1045 | - */ |
|
1046 | - public function brew_espresso() |
|
1047 | - { |
|
1048 | - do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
1049 | - // load some final core systems |
|
1050 | - add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
1051 | - add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
1052 | - add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
1053 | - add_action('init', array($this, 'load_controllers'), 7); |
|
1054 | - add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
1055 | - add_action('init', array($this, 'initialize'), 10); |
|
1056 | - add_action('init', array($this, 'initialize_last'), 100); |
|
1057 | - if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
1058 | - // pew pew pew |
|
1059 | - $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService'); |
|
1060 | - do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
1061 | - } |
|
1062 | - do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
1063 | - } |
|
1064 | - |
|
1065 | - |
|
1066 | - |
|
1067 | - /** |
|
1068 | - * set_hooks_for_core |
|
1069 | - * |
|
1070 | - * @access public |
|
1071 | - * @return void |
|
1072 | - * @throws EE_Error |
|
1073 | - */ |
|
1074 | - public function set_hooks_for_core() |
|
1075 | - { |
|
1076 | - $this->_deactivate_incompatible_addons(); |
|
1077 | - do_action('AHEE__EE_System__set_hooks_for_core'); |
|
1078 | - $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
1079 | - //caps need to be initialized on every request so that capability maps are set. |
|
1080 | - //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
1081 | - $this->registry->CAP->init_caps(); |
|
1082 | - } |
|
1083 | - |
|
1084 | - |
|
1085 | - |
|
1086 | - /** |
|
1087 | - * Using the information gathered in EE_System::_incompatible_addon_error, |
|
1088 | - * deactivates any addons considered incompatible with the current version of EE |
|
1089 | - */ |
|
1090 | - private function _deactivate_incompatible_addons() |
|
1091 | - { |
|
1092 | - $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
1093 | - if (! empty($incompatible_addons)) { |
|
1094 | - $active_plugins = get_option('active_plugins', array()); |
|
1095 | - foreach ($active_plugins as $active_plugin) { |
|
1096 | - foreach ($incompatible_addons as $incompatible_addon) { |
|
1097 | - if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
1098 | - unset($_GET['activate']); |
|
1099 | - espresso_deactivate_plugin($active_plugin); |
|
1100 | - } |
|
1101 | - } |
|
1102 | - } |
|
1103 | - } |
|
1104 | - } |
|
1105 | - |
|
1106 | - |
|
1107 | - |
|
1108 | - /** |
|
1109 | - * perform_activations_upgrades_and_migrations |
|
1110 | - * |
|
1111 | - * @access public |
|
1112 | - * @return void |
|
1113 | - */ |
|
1114 | - public function perform_activations_upgrades_and_migrations() |
|
1115 | - { |
|
1116 | - do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
1117 | - } |
|
1118 | - |
|
1119 | - |
|
1120 | - |
|
1121 | - /** |
|
1122 | - * load_CPTs_and_session |
|
1123 | - * |
|
1124 | - * @access public |
|
1125 | - * @return void |
|
1126 | - */ |
|
1127 | - public function load_CPTs_and_session() |
|
1128 | - { |
|
1129 | - do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
1130 | - // register Custom Post Types |
|
1131 | - $this->loader->getShared('EE_Register_CPTs'); |
|
1132 | - do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
1133 | - } |
|
1134 | - |
|
1135 | - |
|
1136 | - |
|
1137 | - /** |
|
1138 | - * load_controllers |
|
1139 | - * this is the best place to load any additional controllers that needs access to EE core. |
|
1140 | - * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
1141 | - * time |
|
1142 | - * |
|
1143 | - * @access public |
|
1144 | - * @return void |
|
1145 | - */ |
|
1146 | - public function load_controllers() |
|
1147 | - { |
|
1148 | - do_action('AHEE__EE_System__load_controllers__start'); |
|
1149 | - // let's get it started |
|
1150 | - if ( |
|
1151 | - ! $this->maintenance_mode->level() |
|
1152 | - && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
1153 | - ) { |
|
1154 | - do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
1155 | - $this->loader->getShared('EE_Front_Controller'); |
|
1156 | - } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
1157 | - do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
1158 | - $this->loader->getShared('EE_Admin'); |
|
1159 | - } |
|
1160 | - do_action('AHEE__EE_System__load_controllers__complete'); |
|
1161 | - } |
|
1162 | - |
|
1163 | - |
|
1164 | - |
|
1165 | - /** |
|
1166 | - * core_loaded_and_ready |
|
1167 | - * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
1168 | - * |
|
1169 | - * @access public |
|
1170 | - * @return void |
|
1171 | - */ |
|
1172 | - public function core_loaded_and_ready() |
|
1173 | - { |
|
1174 | - if ( |
|
1175 | - $this->request->isAdmin() |
|
1176 | - || $this->request->isEeAjax() |
|
1177 | - || $this->request->isFrontend() |
|
1178 | - ) { |
|
1179 | - $this->loader->getShared('EE_Session'); |
|
1180 | - } |
|
1181 | - do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
1182 | - // load_espresso_template_tags |
|
1183 | - if ( |
|
1184 | - is_readable(EE_PUBLIC . 'template_tags.php') |
|
1185 | - && ( |
|
1186 | - $this->request->isFrontend() |
|
1187 | - || $this->request->isAdmin() |
|
1188 | - || $this->request->isIframe() |
|
1189 | - || $this->request->isFeed() |
|
1190 | - ) |
|
1191 | - ) { |
|
1192 | - require_once EE_PUBLIC . 'template_tags.php'; |
|
1193 | - } |
|
1194 | - do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
1195 | - if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) { |
|
1196 | - $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
1197 | - } |
|
1198 | - } |
|
1199 | - |
|
1200 | - |
|
1201 | - |
|
1202 | - /** |
|
1203 | - * initialize |
|
1204 | - * this is the best place to begin initializing client code |
|
1205 | - * |
|
1206 | - * @access public |
|
1207 | - * @return void |
|
1208 | - */ |
|
1209 | - public function initialize() |
|
1210 | - { |
|
1211 | - do_action('AHEE__EE_System__initialize'); |
|
1212 | - } |
|
1213 | - |
|
1214 | - |
|
1215 | - |
|
1216 | - /** |
|
1217 | - * initialize_last |
|
1218 | - * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
1219 | - * initialize has done so |
|
1220 | - * |
|
1221 | - * @access public |
|
1222 | - * @return void |
|
1223 | - */ |
|
1224 | - public function initialize_last() |
|
1225 | - { |
|
1226 | - do_action('AHEE__EE_System__initialize_last'); |
|
1227 | - add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
1228 | - } |
|
1229 | - |
|
1230 | - |
|
1231 | - |
|
1232 | - /** |
|
1233 | - * @return void |
|
1234 | - * @throws EE_Error |
|
1235 | - */ |
|
1236 | - public function addEspressoToolbar() |
|
1237 | - { |
|
1238 | - $this->loader->getShared( |
|
1239 | - 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
1240 | - array($this->registry->CAP) |
|
1241 | - ); |
|
1242 | - } |
|
1243 | - |
|
1244 | - |
|
1245 | - |
|
1246 | - /** |
|
1247 | - * do_not_cache |
|
1248 | - * sets no cache headers and defines no cache constants for WP plugins |
|
1249 | - * |
|
1250 | - * @access public |
|
1251 | - * @return void |
|
1252 | - */ |
|
1253 | - public static function do_not_cache() |
|
1254 | - { |
|
1255 | - // set no cache constants |
|
1256 | - if (! defined('DONOTCACHEPAGE')) { |
|
1257 | - define('DONOTCACHEPAGE', true); |
|
1258 | - } |
|
1259 | - if (! defined('DONOTCACHCEOBJECT')) { |
|
1260 | - define('DONOTCACHCEOBJECT', true); |
|
1261 | - } |
|
1262 | - if (! defined('DONOTCACHEDB')) { |
|
1263 | - define('DONOTCACHEDB', true); |
|
1264 | - } |
|
1265 | - // add no cache headers |
|
1266 | - add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
1267 | - // plus a little extra for nginx and Google Chrome |
|
1268 | - add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
1269 | - // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
1270 | - remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
1271 | - } |
|
1272 | - |
|
1273 | - |
|
1274 | - |
|
1275 | - /** |
|
1276 | - * extra_nocache_headers |
|
1277 | - * |
|
1278 | - * @access public |
|
1279 | - * @param $headers |
|
1280 | - * @return array |
|
1281 | - */ |
|
1282 | - public static function extra_nocache_headers($headers) |
|
1283 | - { |
|
1284 | - // for NGINX |
|
1285 | - $headers['X-Accel-Expires'] = 0; |
|
1286 | - // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
1287 | - $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
1288 | - return $headers; |
|
1289 | - } |
|
1290 | - |
|
1291 | - |
|
1292 | - |
|
1293 | - /** |
|
1294 | - * nocache_headers |
|
1295 | - * |
|
1296 | - * @access public |
|
1297 | - * @return void |
|
1298 | - */ |
|
1299 | - public static function nocache_headers() |
|
1300 | - { |
|
1301 | - nocache_headers(); |
|
1302 | - } |
|
1303 | - |
|
1304 | - |
|
1305 | - |
|
1306 | - /** |
|
1307 | - * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
1308 | - * never returned with the function. |
|
1309 | - * |
|
1310 | - * @param array $exclude_array any existing pages being excluded are in this array. |
|
1311 | - * @return array |
|
1312 | - */ |
|
1313 | - public function remove_pages_from_wp_list_pages($exclude_array) |
|
1314 | - { |
|
1315 | - return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
1316 | - } |
|
35 | + /** |
|
36 | + * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation. |
|
37 | + * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc |
|
38 | + */ |
|
39 | + const req_type_normal = 0; |
|
40 | + |
|
41 | + /** |
|
42 | + * Indicates this is a brand new installation of EE so we should install |
|
43 | + * tables and default data etc |
|
44 | + */ |
|
45 | + const req_type_new_activation = 1; |
|
46 | + |
|
47 | + /** |
|
48 | + * we've detected that EE has been reactivated (or EE was activated during maintenance mode, |
|
49 | + * and we just exited maintenance mode). We MUST check the database is setup properly |
|
50 | + * and that default data is setup too |
|
51 | + */ |
|
52 | + const req_type_reactivation = 2; |
|
53 | + |
|
54 | + /** |
|
55 | + * indicates that EE has been upgraded since its previous request. |
|
56 | + * We may have data migration scripts to call and will want to trigger maintenance mode |
|
57 | + */ |
|
58 | + const req_type_upgrade = 3; |
|
59 | + |
|
60 | + /** |
|
61 | + * TODO will detect that EE has been DOWNGRADED. We probably don't want to run in this case... |
|
62 | + */ |
|
63 | + const req_type_downgrade = 4; |
|
64 | + |
|
65 | + /** |
|
66 | + * @deprecated since version 4.6.0.dev.006 |
|
67 | + * Now whenever a new_activation is detected the request type is still just |
|
68 | + * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode |
|
69 | + * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required |
|
70 | + * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode. |
|
71 | + * (Specifically, when the migration manager indicates migrations are finished |
|
72 | + * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called) |
|
73 | + */ |
|
74 | + const req_type_activation_but_not_installed = 5; |
|
75 | + |
|
76 | + /** |
|
77 | + * option prefix for recording the activation history (like core's "espresso_db_update") of addons |
|
78 | + */ |
|
79 | + const addon_activation_history_option_prefix = 'ee_addon_activation_history_'; |
|
80 | + |
|
81 | + |
|
82 | + /** |
|
83 | + * @var EE_System $_instance |
|
84 | + */ |
|
85 | + private static $_instance; |
|
86 | + |
|
87 | + /** |
|
88 | + * @var EE_Registry $registry |
|
89 | + */ |
|
90 | + private $registry; |
|
91 | + |
|
92 | + /** |
|
93 | + * @var LoaderInterface $loader |
|
94 | + */ |
|
95 | + private $loader; |
|
96 | + |
|
97 | + /** |
|
98 | + * @var EE_Capabilities $capabilities |
|
99 | + */ |
|
100 | + private $capabilities; |
|
101 | + |
|
102 | + /** |
|
103 | + * @var RequestInterface $request |
|
104 | + */ |
|
105 | + private $request; |
|
106 | + |
|
107 | + /** |
|
108 | + * @var EE_Maintenance_Mode $maintenance_mode |
|
109 | + */ |
|
110 | + private $maintenance_mode; |
|
111 | + |
|
112 | + /** |
|
113 | + * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*. |
|
114 | + * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request. |
|
115 | + * |
|
116 | + * @var int $_req_type |
|
117 | + */ |
|
118 | + private $_req_type; |
|
119 | + |
|
120 | + /** |
|
121 | + * Whether or not there was a non-micro version change in EE core version during this request |
|
122 | + * |
|
123 | + * @var boolean $_major_version_change |
|
124 | + */ |
|
125 | + private $_major_version_change = false; |
|
126 | + |
|
127 | + /** |
|
128 | + * A Context DTO dedicated solely to identifying the current request type. |
|
129 | + * |
|
130 | + * @var RequestTypeContextCheckerInterface $request_type |
|
131 | + */ |
|
132 | + private $request_type; |
|
133 | + |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * @singleton method used to instantiate class object |
|
138 | + * @param EE_Registry|null $registry |
|
139 | + * @param LoaderInterface|null $loader |
|
140 | + * @param RequestInterface|null $request |
|
141 | + * @param EE_Maintenance_Mode|null $maintenance_mode |
|
142 | + * @return EE_System |
|
143 | + */ |
|
144 | + public static function instance( |
|
145 | + EE_Registry $registry = null, |
|
146 | + LoaderInterface $loader = null, |
|
147 | + RequestInterface $request = null, |
|
148 | + EE_Maintenance_Mode $maintenance_mode = null |
|
149 | + ) { |
|
150 | + // check if class object is instantiated |
|
151 | + if (! self::$_instance instanceof EE_System) { |
|
152 | + self::$_instance = new self($registry, $loader, $request, $maintenance_mode); |
|
153 | + } |
|
154 | + return self::$_instance; |
|
155 | + } |
|
156 | + |
|
157 | + |
|
158 | + |
|
159 | + /** |
|
160 | + * resets the instance and returns it |
|
161 | + * |
|
162 | + * @return EE_System |
|
163 | + */ |
|
164 | + public static function reset() |
|
165 | + { |
|
166 | + self::$_instance->_req_type = null; |
|
167 | + //make sure none of the old hooks are left hanging around |
|
168 | + remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
169 | + //we need to reset the migration manager in order for it to detect DMSs properly |
|
170 | + EE_Data_Migration_Manager::reset(); |
|
171 | + self::instance()->detect_activations_or_upgrades(); |
|
172 | + self::instance()->perform_activations_upgrades_and_migrations(); |
|
173 | + return self::instance(); |
|
174 | + } |
|
175 | + |
|
176 | + |
|
177 | + |
|
178 | + /** |
|
179 | + * sets hooks for running rest of system |
|
180 | + * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
181 | + * starting EE Addons from any other point may lead to problems |
|
182 | + * |
|
183 | + * @param EE_Registry $registry |
|
184 | + * @param LoaderInterface $loader |
|
185 | + * @param RequestInterface $request |
|
186 | + * @param EE_Maintenance_Mode $maintenance_mode |
|
187 | + */ |
|
188 | + private function __construct( |
|
189 | + EE_Registry $registry, |
|
190 | + LoaderInterface $loader, |
|
191 | + RequestInterface $request, |
|
192 | + EE_Maintenance_Mode $maintenance_mode |
|
193 | + ) { |
|
194 | + $this->registry = $registry; |
|
195 | + $this->loader = $loader; |
|
196 | + $this->request = $request; |
|
197 | + $this->maintenance_mode = $maintenance_mode; |
|
198 | + do_action('AHEE__EE_System__construct__begin', $this); |
|
199 | + add_action( |
|
200 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
201 | + array($this, 'loadCapabilities'), |
|
202 | + 5 |
|
203 | + ); |
|
204 | + add_action( |
|
205 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
206 | + array($this, 'loadCommandBus'), |
|
207 | + 7 |
|
208 | + ); |
|
209 | + add_action( |
|
210 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
211 | + array($this, 'loadPluginApi'), |
|
212 | + 9 |
|
213 | + ); |
|
214 | + // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc |
|
215 | + add_action( |
|
216 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
217 | + array($this, 'load_espresso_addons') |
|
218 | + ); |
|
219 | + // when an ee addon is activated, we want to call the core hook(s) again |
|
220 | + // because the newly-activated addon didn't get a chance to run at all |
|
221 | + add_action('activate_plugin', array($this, 'load_espresso_addons'), 1); |
|
222 | + // detect whether install or upgrade |
|
223 | + add_action( |
|
224 | + 'AHEE__EE_Bootstrap__detect_activations_or_upgrades', |
|
225 | + array($this, 'detect_activations_or_upgrades'), |
|
226 | + 3 |
|
227 | + ); |
|
228 | + // load EE_Config, EE_Textdomain, etc |
|
229 | + add_action( |
|
230 | + 'AHEE__EE_Bootstrap__load_core_configuration', |
|
231 | + array($this, 'load_core_configuration'), |
|
232 | + 5 |
|
233 | + ); |
|
234 | + // load EE_Config, EE_Textdomain, etc |
|
235 | + add_action( |
|
236 | + 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets', |
|
237 | + array($this, 'register_shortcodes_modules_and_widgets'), |
|
238 | + 7 |
|
239 | + ); |
|
240 | + // you wanna get going? I wanna get going... let's get going! |
|
241 | + add_action( |
|
242 | + 'AHEE__EE_Bootstrap__brew_espresso', |
|
243 | + array($this, 'brew_espresso'), |
|
244 | + 9 |
|
245 | + ); |
|
246 | + //other housekeeping |
|
247 | + //exclude EE critical pages from wp_list_pages |
|
248 | + add_filter( |
|
249 | + 'wp_list_pages_excludes', |
|
250 | + array($this, 'remove_pages_from_wp_list_pages'), |
|
251 | + 10 |
|
252 | + ); |
|
253 | + // ALL EE Addons should use the following hook point to attach their initial setup too |
|
254 | + // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads |
|
255 | + do_action('AHEE__EE_System__construct__complete', $this); |
|
256 | + } |
|
257 | + |
|
258 | + |
|
259 | + /** |
|
260 | + * load and setup EE_Capabilities |
|
261 | + * |
|
262 | + * @return void |
|
263 | + * @throws EE_Error |
|
264 | + */ |
|
265 | + public function loadCapabilities() |
|
266 | + { |
|
267 | + $this->capabilities = $this->loader->getShared('EE_Capabilities'); |
|
268 | + add_action( |
|
269 | + 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
270 | + function () |
|
271 | + { |
|
272 | + LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager'); |
|
273 | + } |
|
274 | + ); |
|
275 | + } |
|
276 | + |
|
277 | + |
|
278 | + |
|
279 | + /** |
|
280 | + * create and cache the CommandBus, and also add middleware |
|
281 | + * The CapChecker middleware requires the use of EE_Capabilities |
|
282 | + * which is why we need to load the CommandBus after Caps are set up |
|
283 | + * |
|
284 | + * @return void |
|
285 | + * @throws EE_Error |
|
286 | + */ |
|
287 | + public function loadCommandBus() |
|
288 | + { |
|
289 | + $this->loader->getShared( |
|
290 | + 'CommandBusInterface', |
|
291 | + array( |
|
292 | + null, |
|
293 | + apply_filters( |
|
294 | + 'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware', |
|
295 | + array( |
|
296 | + $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'), |
|
297 | + $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'), |
|
298 | + ) |
|
299 | + ), |
|
300 | + ) |
|
301 | + ); |
|
302 | + } |
|
303 | + |
|
304 | + |
|
305 | + |
|
306 | + /** |
|
307 | + * @return void |
|
308 | + * @throws EE_Error |
|
309 | + */ |
|
310 | + public function loadPluginApi() |
|
311 | + { |
|
312 | + // set autoloaders for all of the classes implementing EEI_Plugin_API |
|
313 | + // which provide helpers for EE plugin authors to more easily register certain components with EE. |
|
314 | + EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api'); |
|
315 | + $this->loader->getShared('EE_Request_Handler'); |
|
316 | + } |
|
317 | + |
|
318 | + |
|
319 | + /** |
|
320 | + * @param string $addon_name |
|
321 | + * @param string $version_constant |
|
322 | + * @param string $min_version_required |
|
323 | + * @param string $load_callback |
|
324 | + * @param string $plugin_file_constant |
|
325 | + * @return void |
|
326 | + */ |
|
327 | + private function deactivateIncompatibleAddon( |
|
328 | + $addon_name, |
|
329 | + $version_constant, |
|
330 | + $min_version_required, |
|
331 | + $load_callback, |
|
332 | + $plugin_file_constant |
|
333 | + ) { |
|
334 | + if (! defined($version_constant)) { |
|
335 | + return; |
|
336 | + } |
|
337 | + $addon_version = constant($version_constant); |
|
338 | + if ($addon_version && version_compare($addon_version, $min_version_required, '<')) { |
|
339 | + remove_action('AHEE__EE_System__load_espresso_addons', $load_callback); |
|
340 | + if (! function_exists('deactivate_plugins')) { |
|
341 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
342 | + } |
|
343 | + deactivate_plugins(plugin_basename(constant($plugin_file_constant))); |
|
344 | + unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']); |
|
345 | + EE_Error::add_error( |
|
346 | + sprintf( |
|
347 | + esc_html__( |
|
348 | + 'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.', |
|
349 | + 'event_espresso' |
|
350 | + ), |
|
351 | + $addon_name, |
|
352 | + $min_version_required |
|
353 | + ), |
|
354 | + __FILE__, __FUNCTION__ . "({$addon_name})", __LINE__ |
|
355 | + ); |
|
356 | + EE_Error::get_notices(false, true); |
|
357 | + } |
|
358 | + } |
|
359 | + |
|
360 | + |
|
361 | + /** |
|
362 | + * load_espresso_addons |
|
363 | + * allow addons to load first so that they can set hooks for running DMS's, etc |
|
364 | + * this is hooked into both: |
|
365 | + * 'AHEE__EE_Bootstrap__load_core_configuration' |
|
366 | + * which runs during the WP 'plugins_loaded' action at priority 5 |
|
367 | + * and the WP 'activate_plugin' hook point |
|
368 | + * |
|
369 | + * @access public |
|
370 | + * @return void |
|
371 | + */ |
|
372 | + public function load_espresso_addons() |
|
373 | + { |
|
374 | + $this->deactivateIncompatibleAddon( |
|
375 | + 'Wait Lists', |
|
376 | + 'EE_WAIT_LISTS_VERSION', |
|
377 | + '1.0.0.beta.074', |
|
378 | + 'load_espresso_wait_lists', |
|
379 | + 'EE_WAIT_LISTS_PLUGIN_FILE' |
|
380 | + ); |
|
381 | + $this->deactivateIncompatibleAddon( |
|
382 | + 'Automated Upcoming Event Notifications', |
|
383 | + 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION', |
|
384 | + '1.0.0.beta.091', |
|
385 | + 'load_espresso_automated_upcoming_event_notification', |
|
386 | + 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE' |
|
387 | + ); |
|
388 | + do_action('AHEE__EE_System__load_espresso_addons'); |
|
389 | + //if the WP API basic auth plugin isn't already loaded, load it now. |
|
390 | + //We want it for mobile apps. Just include the entire plugin |
|
391 | + //also, don't load the basic auth when a plugin is getting activated, because |
|
392 | + //it could be the basic auth plugin, and it doesn't check if its methods are already defined |
|
393 | + //and causes a fatal error |
|
394 | + if ( |
|
395 | + $this->request->getRequestParam('activate') !== 'true' |
|
396 | + && ! function_exists('json_basic_auth_handler') |
|
397 | + && ! function_exists('json_basic_auth_error') |
|
398 | + && ! in_array( |
|
399 | + $this->request->getRequestParam('action'), |
|
400 | + array('activate', 'activate-selected'), |
|
401 | + true |
|
402 | + ) |
|
403 | + ) { |
|
404 | + include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php'; |
|
405 | + } |
|
406 | + do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
407 | + } |
|
408 | + |
|
409 | + |
|
410 | + |
|
411 | + /** |
|
412 | + * detect_activations_or_upgrades |
|
413 | + * Checks for activation or upgrade of core first; |
|
414 | + * then also checks if any registered addons have been activated or upgraded |
|
415 | + * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
416 | + * which runs during the WP 'plugins_loaded' action at priority 3 |
|
417 | + * |
|
418 | + * @access public |
|
419 | + * @return void |
|
420 | + */ |
|
421 | + public function detect_activations_or_upgrades() |
|
422 | + { |
|
423 | + //first off: let's make sure to handle core |
|
424 | + $this->detect_if_activation_or_upgrade(); |
|
425 | + foreach ($this->registry->addons as $addon) { |
|
426 | + if ($addon instanceof EE_Addon) { |
|
427 | + //detect teh request type for that addon |
|
428 | + $addon->detect_activation_or_upgrade(); |
|
429 | + } |
|
430 | + } |
|
431 | + } |
|
432 | + |
|
433 | + |
|
434 | + |
|
435 | + /** |
|
436 | + * detect_if_activation_or_upgrade |
|
437 | + * Takes care of detecting whether this is a brand new install or code upgrade, |
|
438 | + * and either setting up the DB or setting up maintenance mode etc. |
|
439 | + * |
|
440 | + * @access public |
|
441 | + * @return void |
|
442 | + */ |
|
443 | + public function detect_if_activation_or_upgrade() |
|
444 | + { |
|
445 | + do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
446 | + // check if db has been updated, or if its a brand-new installation |
|
447 | + $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
448 | + $request_type = $this->detect_req_type($espresso_db_update); |
|
449 | + //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
450 | + switch ($request_type) { |
|
451 | + case EE_System::req_type_new_activation: |
|
452 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
453 | + $this->_handle_core_version_change($espresso_db_update); |
|
454 | + break; |
|
455 | + case EE_System::req_type_reactivation: |
|
456 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
457 | + $this->_handle_core_version_change($espresso_db_update); |
|
458 | + break; |
|
459 | + case EE_System::req_type_upgrade: |
|
460 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
461 | + //migrations may be required now that we've upgraded |
|
462 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
463 | + $this->_handle_core_version_change($espresso_db_update); |
|
464 | + // echo "done upgrade";die; |
|
465 | + break; |
|
466 | + case EE_System::req_type_downgrade: |
|
467 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
468 | + //its possible migrations are no longer required |
|
469 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
470 | + $this->_handle_core_version_change($espresso_db_update); |
|
471 | + break; |
|
472 | + case EE_System::req_type_normal: |
|
473 | + default: |
|
474 | + break; |
|
475 | + } |
|
476 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
477 | + } |
|
478 | + |
|
479 | + |
|
480 | + |
|
481 | + /** |
|
482 | + * Updates the list of installed versions and sets hooks for |
|
483 | + * initializing the database later during the request |
|
484 | + * |
|
485 | + * @param array $espresso_db_update |
|
486 | + */ |
|
487 | + private function _handle_core_version_change($espresso_db_update) |
|
488 | + { |
|
489 | + $this->update_list_of_installed_versions($espresso_db_update); |
|
490 | + //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
491 | + add_action( |
|
492 | + 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
493 | + array($this, 'initialize_db_if_no_migrations_required') |
|
494 | + ); |
|
495 | + } |
|
496 | + |
|
497 | + |
|
498 | + |
|
499 | + /** |
|
500 | + * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
501 | + * information about what versions of EE have been installed and activated, |
|
502 | + * NOT necessarily the state of the database |
|
503 | + * |
|
504 | + * @param mixed $espresso_db_update the value of the WordPress option. |
|
505 | + * If not supplied, fetches it from the options table |
|
506 | + * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
507 | + */ |
|
508 | + private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
509 | + { |
|
510 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
511 | + if (! $espresso_db_update) { |
|
512 | + $espresso_db_update = get_option('espresso_db_update'); |
|
513 | + } |
|
514 | + // check that option is an array |
|
515 | + if (! is_array($espresso_db_update)) { |
|
516 | + // if option is FALSE, then it never existed |
|
517 | + if ($espresso_db_update === false) { |
|
518 | + // make $espresso_db_update an array and save option with autoload OFF |
|
519 | + $espresso_db_update = array(); |
|
520 | + add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
521 | + } else { |
|
522 | + // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
523 | + $espresso_db_update = array($espresso_db_update => array()); |
|
524 | + update_option('espresso_db_update', $espresso_db_update); |
|
525 | + } |
|
526 | + } else { |
|
527 | + $corrected_db_update = array(); |
|
528 | + //if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
529 | + foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
530 | + if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
531 | + //the key is an int, and the value IS NOT an array |
|
532 | + //so it must be numerically-indexed, where values are versions installed... |
|
533 | + //fix it! |
|
534 | + $version_string = $should_be_array; |
|
535 | + $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
536 | + } else { |
|
537 | + //ok it checks out |
|
538 | + $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
539 | + } |
|
540 | + } |
|
541 | + $espresso_db_update = $corrected_db_update; |
|
542 | + update_option('espresso_db_update', $espresso_db_update); |
|
543 | + } |
|
544 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
545 | + return $espresso_db_update; |
|
546 | + } |
|
547 | + |
|
548 | + |
|
549 | + |
|
550 | + /** |
|
551 | + * Does the traditional work of setting up the plugin's database and adding default data. |
|
552 | + * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
553 | + * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
554 | + * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
555 | + * so that it will be done when migrations are finished |
|
556 | + * |
|
557 | + * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
558 | + * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
559 | + * This is a resource-intensive job |
|
560 | + * so we prefer to only do it when necessary |
|
561 | + * @return void |
|
562 | + * @throws EE_Error |
|
563 | + */ |
|
564 | + public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
565 | + { |
|
566 | + $request_type = $this->detect_req_type(); |
|
567 | + //only initialize system if we're not in maintenance mode. |
|
568 | + if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
569 | + update_option('ee_flush_rewrite_rules', true); |
|
570 | + if ($verify_schema) { |
|
571 | + EEH_Activation::initialize_db_and_folders(); |
|
572 | + } |
|
573 | + EEH_Activation::initialize_db_content(); |
|
574 | + EEH_Activation::system_initialization(); |
|
575 | + if ($initialize_addons_too) { |
|
576 | + $this->initialize_addons(); |
|
577 | + } |
|
578 | + } else { |
|
579 | + EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
580 | + } |
|
581 | + if ($request_type === EE_System::req_type_new_activation |
|
582 | + || $request_type === EE_System::req_type_reactivation |
|
583 | + || ( |
|
584 | + $request_type === EE_System::req_type_upgrade |
|
585 | + && $this->is_major_version_change() |
|
586 | + ) |
|
587 | + ) { |
|
588 | + add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
589 | + } |
|
590 | + } |
|
591 | + |
|
592 | + |
|
593 | + |
|
594 | + /** |
|
595 | + * Initializes the db for all registered addons |
|
596 | + * |
|
597 | + * @throws EE_Error |
|
598 | + */ |
|
599 | + public function initialize_addons() |
|
600 | + { |
|
601 | + //foreach registered addon, make sure its db is up-to-date too |
|
602 | + foreach ($this->registry->addons as $addon) { |
|
603 | + if ($addon instanceof EE_Addon) { |
|
604 | + $addon->initialize_db_if_no_migrations_required(); |
|
605 | + } |
|
606 | + } |
|
607 | + } |
|
608 | + |
|
609 | + |
|
610 | + |
|
611 | + /** |
|
612 | + * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
613 | + * |
|
614 | + * @param array $version_history |
|
615 | + * @param string $current_version_to_add version to be added to the version history |
|
616 | + * @return boolean success as to whether or not this option was changed |
|
617 | + */ |
|
618 | + public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
619 | + { |
|
620 | + if (! $version_history) { |
|
621 | + $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
622 | + } |
|
623 | + if ($current_version_to_add === null) { |
|
624 | + $current_version_to_add = espresso_version(); |
|
625 | + } |
|
626 | + $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
627 | + // re-save |
|
628 | + return update_option('espresso_db_update', $version_history); |
|
629 | + } |
|
630 | + |
|
631 | + |
|
632 | + |
|
633 | + /** |
|
634 | + * Detects if the current version indicated in the has existed in the list of |
|
635 | + * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
636 | + * |
|
637 | + * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
638 | + * If not supplied, fetches it from the options table. |
|
639 | + * Also, caches its result so later parts of the code can also know whether |
|
640 | + * there's been an update or not. This way we can add the current version to |
|
641 | + * espresso_db_update, but still know if this is a new install or not |
|
642 | + * @return int one of the constants on EE_System::req_type_ |
|
643 | + */ |
|
644 | + public function detect_req_type($espresso_db_update = null) |
|
645 | + { |
|
646 | + if ($this->_req_type === null) { |
|
647 | + $espresso_db_update = ! empty($espresso_db_update) |
|
648 | + ? $espresso_db_update |
|
649 | + : $this->fix_espresso_db_upgrade_option(); |
|
650 | + $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
651 | + $espresso_db_update, |
|
652 | + 'ee_espresso_activation', espresso_version() |
|
653 | + ); |
|
654 | + $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
655 | + $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
656 | + } |
|
657 | + return $this->_req_type; |
|
658 | + } |
|
659 | + |
|
660 | + |
|
661 | + |
|
662 | + /** |
|
663 | + * Returns whether or not there was a non-micro version change (ie, change in either |
|
664 | + * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
665 | + * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
666 | + * |
|
667 | + * @param $activation_history |
|
668 | + * @return bool |
|
669 | + */ |
|
670 | + private function _detect_major_version_change($activation_history) |
|
671 | + { |
|
672 | + $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
673 | + $previous_version_parts = explode('.', $previous_version); |
|
674 | + $current_version_parts = explode('.', espresso_version()); |
|
675 | + return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
676 | + && ($previous_version_parts[0] !== $current_version_parts[0] |
|
677 | + || $previous_version_parts[1] !== $current_version_parts[1] |
|
678 | + ); |
|
679 | + } |
|
680 | + |
|
681 | + |
|
682 | + |
|
683 | + /** |
|
684 | + * Returns true if either the major or minor version of EE changed during this request. |
|
685 | + * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
686 | + * |
|
687 | + * @return bool |
|
688 | + */ |
|
689 | + public function is_major_version_change() |
|
690 | + { |
|
691 | + return $this->_major_version_change; |
|
692 | + } |
|
693 | + |
|
694 | + |
|
695 | + |
|
696 | + /** |
|
697 | + * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
698 | + * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
699 | + * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
700 | + * just activated to (for core that will always be espresso_version()) |
|
701 | + * |
|
702 | + * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
703 | + * ee plugin. for core that's 'espresso_db_update' |
|
704 | + * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
705 | + * indicate that this plugin was just activated |
|
706 | + * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
707 | + * espresso_version()) |
|
708 | + * @return int one of the constants on EE_System::req_type_* |
|
709 | + */ |
|
710 | + public static function detect_req_type_given_activation_history( |
|
711 | + $activation_history_for_addon, |
|
712 | + $activation_indicator_option_name, |
|
713 | + $version_to_upgrade_to |
|
714 | + ) { |
|
715 | + $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
716 | + if ($activation_history_for_addon) { |
|
717 | + //it exists, so this isn't a completely new install |
|
718 | + //check if this version already in that list of previously installed versions |
|
719 | + if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
720 | + //it a version we haven't seen before |
|
721 | + if ($version_is_higher === 1) { |
|
722 | + $req_type = EE_System::req_type_upgrade; |
|
723 | + } else { |
|
724 | + $req_type = EE_System::req_type_downgrade; |
|
725 | + } |
|
726 | + delete_option($activation_indicator_option_name); |
|
727 | + } else { |
|
728 | + // its not an update. maybe a reactivation? |
|
729 | + if (get_option($activation_indicator_option_name, false)) { |
|
730 | + if ($version_is_higher === -1) { |
|
731 | + $req_type = EE_System::req_type_downgrade; |
|
732 | + } elseif ($version_is_higher === 0) { |
|
733 | + //we've seen this version before, but it's an activation. must be a reactivation |
|
734 | + $req_type = EE_System::req_type_reactivation; |
|
735 | + } else {//$version_is_higher === 1 |
|
736 | + $req_type = EE_System::req_type_upgrade; |
|
737 | + } |
|
738 | + delete_option($activation_indicator_option_name); |
|
739 | + } else { |
|
740 | + //we've seen this version before and the activation indicate doesn't show it was just activated |
|
741 | + if ($version_is_higher === -1) { |
|
742 | + $req_type = EE_System::req_type_downgrade; |
|
743 | + } elseif ($version_is_higher === 0) { |
|
744 | + //we've seen this version before and it's not an activation. its normal request |
|
745 | + $req_type = EE_System::req_type_normal; |
|
746 | + } else {//$version_is_higher === 1 |
|
747 | + $req_type = EE_System::req_type_upgrade; |
|
748 | + } |
|
749 | + } |
|
750 | + } |
|
751 | + } else { |
|
752 | + //brand new install |
|
753 | + $req_type = EE_System::req_type_new_activation; |
|
754 | + delete_option($activation_indicator_option_name); |
|
755 | + } |
|
756 | + return $req_type; |
|
757 | + } |
|
758 | + |
|
759 | + |
|
760 | + |
|
761 | + /** |
|
762 | + * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
763 | + * the $activation_history_for_addon |
|
764 | + * |
|
765 | + * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
766 | + * sometimes containing 'unknown-date' |
|
767 | + * @param string $version_to_upgrade_to (current version) |
|
768 | + * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
769 | + * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
770 | + * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
771 | + * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
772 | + */ |
|
773 | + private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
774 | + { |
|
775 | + //find the most recently-activated version |
|
776 | + $most_recently_active_version = |
|
777 | + EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
778 | + return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
779 | + } |
|
780 | + |
|
781 | + |
|
782 | + |
|
783 | + /** |
|
784 | + * Gets the most recently active version listed in the activation history, |
|
785 | + * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
786 | + * |
|
787 | + * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
788 | + * sometimes containing 'unknown-date' |
|
789 | + * @return string |
|
790 | + */ |
|
791 | + private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
792 | + { |
|
793 | + $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
794 | + $most_recently_active_version = '0.0.0.dev.000'; |
|
795 | + if (is_array($activation_history)) { |
|
796 | + foreach ($activation_history as $version => $times_activated) { |
|
797 | + //check there is a record of when this version was activated. Otherwise, |
|
798 | + //mark it as unknown |
|
799 | + if (! $times_activated) { |
|
800 | + $times_activated = array('unknown-date'); |
|
801 | + } |
|
802 | + if (is_string($times_activated)) { |
|
803 | + $times_activated = array($times_activated); |
|
804 | + } |
|
805 | + foreach ($times_activated as $an_activation) { |
|
806 | + if ($an_activation !== 'unknown-date' |
|
807 | + && $an_activation |
|
808 | + > $most_recently_active_version_activation) { |
|
809 | + $most_recently_active_version = $version; |
|
810 | + $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
811 | + ? '1970-01-01 00:00:00' |
|
812 | + : $an_activation; |
|
813 | + } |
|
814 | + } |
|
815 | + } |
|
816 | + } |
|
817 | + return $most_recently_active_version; |
|
818 | + } |
|
819 | + |
|
820 | + |
|
821 | + |
|
822 | + /** |
|
823 | + * This redirects to the about EE page after activation |
|
824 | + * |
|
825 | + * @return void |
|
826 | + */ |
|
827 | + public function redirect_to_about_ee() |
|
828 | + { |
|
829 | + $notices = EE_Error::get_notices(false); |
|
830 | + //if current user is an admin and it's not an ajax or rest request |
|
831 | + if ( |
|
832 | + ! isset($notices['errors']) |
|
833 | + && $this->request->isAdmin() |
|
834 | + && apply_filters( |
|
835 | + 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
836 | + $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
837 | + ) |
|
838 | + ) { |
|
839 | + $query_params = array('page' => 'espresso_about'); |
|
840 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
841 | + $query_params['new_activation'] = true; |
|
842 | + } |
|
843 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
844 | + $query_params['reactivation'] = true; |
|
845 | + } |
|
846 | + $url = add_query_arg($query_params, admin_url('admin.php')); |
|
847 | + wp_safe_redirect($url); |
|
848 | + exit(); |
|
849 | + } |
|
850 | + } |
|
851 | + |
|
852 | + |
|
853 | + |
|
854 | + /** |
|
855 | + * load_core_configuration |
|
856 | + * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
857 | + * which runs during the WP 'plugins_loaded' action at priority 5 |
|
858 | + * |
|
859 | + * @return void |
|
860 | + * @throws ReflectionException |
|
861 | + */ |
|
862 | + public function load_core_configuration() |
|
863 | + { |
|
864 | + do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
865 | + $this->loader->getShared('EE_Load_Textdomain'); |
|
866 | + //load textdomain |
|
867 | + EE_Load_Textdomain::load_textdomain(); |
|
868 | + // load and setup EE_Config and EE_Network_Config |
|
869 | + $config = $this->loader->getShared('EE_Config'); |
|
870 | + $this->loader->getShared('EE_Network_Config'); |
|
871 | + // setup autoloaders |
|
872 | + // enable logging? |
|
873 | + if ($config->admin->use_full_logging) { |
|
874 | + $this->loader->getShared('EE_Log'); |
|
875 | + } |
|
876 | + // check for activation errors |
|
877 | + $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
878 | + if ($activation_errors) { |
|
879 | + EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
880 | + update_option('ee_plugin_activation_errors', false); |
|
881 | + } |
|
882 | + // get model names |
|
883 | + $this->_parse_model_names(); |
|
884 | + //load caf stuff a chance to play during the activation process too. |
|
885 | + $this->_maybe_brew_regular(); |
|
886 | + do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
887 | + } |
|
888 | + |
|
889 | + |
|
890 | + |
|
891 | + /** |
|
892 | + * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
893 | + * |
|
894 | + * @return void |
|
895 | + * @throws ReflectionException |
|
896 | + */ |
|
897 | + private function _parse_model_names() |
|
898 | + { |
|
899 | + //get all the files in the EE_MODELS folder that end in .model.php |
|
900 | + $models = glob(EE_MODELS . '*.model.php'); |
|
901 | + $model_names = array(); |
|
902 | + $non_abstract_db_models = array(); |
|
903 | + foreach ($models as $model) { |
|
904 | + // get model classname |
|
905 | + $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
906 | + $short_name = str_replace('EEM_', '', $classname); |
|
907 | + $reflectionClass = new ReflectionClass($classname); |
|
908 | + if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
909 | + $non_abstract_db_models[ $short_name ] = $classname; |
|
910 | + } |
|
911 | + $model_names[ $short_name ] = $classname; |
|
912 | + } |
|
913 | + $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
914 | + $this->registry->non_abstract_db_models = apply_filters( |
|
915 | + 'FHEE__EE_System__parse_implemented_model_names', |
|
916 | + $non_abstract_db_models |
|
917 | + ); |
|
918 | + } |
|
919 | + |
|
920 | + |
|
921 | + /** |
|
922 | + * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
923 | + * that need to be setup before our EE_System launches. |
|
924 | + * |
|
925 | + * @return void |
|
926 | + * @throws DomainException |
|
927 | + * @throws InvalidArgumentException |
|
928 | + * @throws InvalidDataTypeException |
|
929 | + * @throws InvalidInterfaceException |
|
930 | + * @throws InvalidClassException |
|
931 | + * @throws InvalidFilePathException |
|
932 | + */ |
|
933 | + private function _maybe_brew_regular() |
|
934 | + { |
|
935 | + /** @var Domain $domain */ |
|
936 | + $domain = DomainFactory::getShared( |
|
937 | + new FullyQualifiedName( |
|
938 | + 'EventEspresso\core\domain\Domain' |
|
939 | + ), |
|
940 | + array( |
|
941 | + new FilePath(EVENT_ESPRESSO_MAIN_FILE), |
|
942 | + Version::fromString(espresso_version()) |
|
943 | + ) |
|
944 | + ); |
|
945 | + if ($domain->isCaffeinated()) { |
|
946 | + require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
947 | + } |
|
948 | + } |
|
949 | + |
|
950 | + |
|
951 | + |
|
952 | + /** |
|
953 | + * register_shortcodes_modules_and_widgets |
|
954 | + * generate lists of shortcodes and modules, then verify paths and classes |
|
955 | + * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
956 | + * which runs during the WP 'plugins_loaded' action at priority 7 |
|
957 | + * |
|
958 | + * @access public |
|
959 | + * @return void |
|
960 | + * @throws Exception |
|
961 | + */ |
|
962 | + public function register_shortcodes_modules_and_widgets() |
|
963 | + { |
|
964 | + try { |
|
965 | + // load, register, and add shortcodes the new way |
|
966 | + if ($this->request->isFrontend() || $this->request->isIframe()) { |
|
967 | + $this->loader->getShared( |
|
968 | + 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
969 | + array( |
|
970 | + // and the old way, but we'll put it under control of the new system |
|
971 | + EE_Config::getLegacyShortcodesManager(), |
|
972 | + ) |
|
973 | + ); |
|
974 | + } |
|
975 | + if (function_exists('register_block_type')) { |
|
976 | + $editor_block_collection = $this->loader->getShared( |
|
977 | + 'EventEspresso\core\domain\entities\editor\EditorBlockCollection' |
|
978 | + ); |
|
979 | + // or the even newer newer new way |
|
980 | + if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAdmin()) { |
|
981 | + $this->loader->getShared( |
|
982 | + 'EventEspresso\core\services\editor\EditorBlockRegistrationManager', |
|
983 | + array($editor_block_collection, $this->request) |
|
984 | + ); |
|
985 | + } |
|
986 | + } |
|
987 | + } catch (Exception $exception) { |
|
988 | + new ExceptionStackTraceDisplay($exception); |
|
989 | + } |
|
990 | + do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
991 | + // check for addons using old hook point |
|
992 | + if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
993 | + $this->_incompatible_addon_error(); |
|
994 | + } |
|
995 | + } |
|
996 | + |
|
997 | + |
|
998 | + |
|
999 | + /** |
|
1000 | + * _incompatible_addon_error |
|
1001 | + * |
|
1002 | + * @access public |
|
1003 | + * @return void |
|
1004 | + */ |
|
1005 | + private function _incompatible_addon_error() |
|
1006 | + { |
|
1007 | + // get array of classes hooking into here |
|
1008 | + $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
1009 | + 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
1010 | + ); |
|
1011 | + if (! empty($class_names)) { |
|
1012 | + $msg = __( |
|
1013 | + 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
1014 | + 'event_espresso' |
|
1015 | + ); |
|
1016 | + $msg .= '<ul>'; |
|
1017 | + foreach ($class_names as $class_name) { |
|
1018 | + $msg .= '<li><b>Event Espresso - ' . str_replace( |
|
1019 | + array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '', |
|
1020 | + $class_name |
|
1021 | + ) . '</b></li>'; |
|
1022 | + } |
|
1023 | + $msg .= '</ul>'; |
|
1024 | + $msg .= __( |
|
1025 | + 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
1026 | + 'event_espresso' |
|
1027 | + ); |
|
1028 | + // save list of incompatible addons to wp-options for later use |
|
1029 | + add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
1030 | + if (is_admin()) { |
|
1031 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1032 | + } |
|
1033 | + } |
|
1034 | + } |
|
1035 | + |
|
1036 | + |
|
1037 | + |
|
1038 | + /** |
|
1039 | + * brew_espresso |
|
1040 | + * begins the process of setting hooks for initializing EE in the correct order |
|
1041 | + * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
1042 | + * which runs during the WP 'plugins_loaded' action at priority 9 |
|
1043 | + * |
|
1044 | + * @return void |
|
1045 | + */ |
|
1046 | + public function brew_espresso() |
|
1047 | + { |
|
1048 | + do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
1049 | + // load some final core systems |
|
1050 | + add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
1051 | + add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
1052 | + add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
1053 | + add_action('init', array($this, 'load_controllers'), 7); |
|
1054 | + add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
1055 | + add_action('init', array($this, 'initialize'), 10); |
|
1056 | + add_action('init', array($this, 'initialize_last'), 100); |
|
1057 | + if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
1058 | + // pew pew pew |
|
1059 | + $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService'); |
|
1060 | + do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
1061 | + } |
|
1062 | + do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
1063 | + } |
|
1064 | + |
|
1065 | + |
|
1066 | + |
|
1067 | + /** |
|
1068 | + * set_hooks_for_core |
|
1069 | + * |
|
1070 | + * @access public |
|
1071 | + * @return void |
|
1072 | + * @throws EE_Error |
|
1073 | + */ |
|
1074 | + public function set_hooks_for_core() |
|
1075 | + { |
|
1076 | + $this->_deactivate_incompatible_addons(); |
|
1077 | + do_action('AHEE__EE_System__set_hooks_for_core'); |
|
1078 | + $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
1079 | + //caps need to be initialized on every request so that capability maps are set. |
|
1080 | + //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
1081 | + $this->registry->CAP->init_caps(); |
|
1082 | + } |
|
1083 | + |
|
1084 | + |
|
1085 | + |
|
1086 | + /** |
|
1087 | + * Using the information gathered in EE_System::_incompatible_addon_error, |
|
1088 | + * deactivates any addons considered incompatible with the current version of EE |
|
1089 | + */ |
|
1090 | + private function _deactivate_incompatible_addons() |
|
1091 | + { |
|
1092 | + $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
1093 | + if (! empty($incompatible_addons)) { |
|
1094 | + $active_plugins = get_option('active_plugins', array()); |
|
1095 | + foreach ($active_plugins as $active_plugin) { |
|
1096 | + foreach ($incompatible_addons as $incompatible_addon) { |
|
1097 | + if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
1098 | + unset($_GET['activate']); |
|
1099 | + espresso_deactivate_plugin($active_plugin); |
|
1100 | + } |
|
1101 | + } |
|
1102 | + } |
|
1103 | + } |
|
1104 | + } |
|
1105 | + |
|
1106 | + |
|
1107 | + |
|
1108 | + /** |
|
1109 | + * perform_activations_upgrades_and_migrations |
|
1110 | + * |
|
1111 | + * @access public |
|
1112 | + * @return void |
|
1113 | + */ |
|
1114 | + public function perform_activations_upgrades_and_migrations() |
|
1115 | + { |
|
1116 | + do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
1117 | + } |
|
1118 | + |
|
1119 | + |
|
1120 | + |
|
1121 | + /** |
|
1122 | + * load_CPTs_and_session |
|
1123 | + * |
|
1124 | + * @access public |
|
1125 | + * @return void |
|
1126 | + */ |
|
1127 | + public function load_CPTs_and_session() |
|
1128 | + { |
|
1129 | + do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
1130 | + // register Custom Post Types |
|
1131 | + $this->loader->getShared('EE_Register_CPTs'); |
|
1132 | + do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
1133 | + } |
|
1134 | + |
|
1135 | + |
|
1136 | + |
|
1137 | + /** |
|
1138 | + * load_controllers |
|
1139 | + * this is the best place to load any additional controllers that needs access to EE core. |
|
1140 | + * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
1141 | + * time |
|
1142 | + * |
|
1143 | + * @access public |
|
1144 | + * @return void |
|
1145 | + */ |
|
1146 | + public function load_controllers() |
|
1147 | + { |
|
1148 | + do_action('AHEE__EE_System__load_controllers__start'); |
|
1149 | + // let's get it started |
|
1150 | + if ( |
|
1151 | + ! $this->maintenance_mode->level() |
|
1152 | + && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
1153 | + ) { |
|
1154 | + do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
1155 | + $this->loader->getShared('EE_Front_Controller'); |
|
1156 | + } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
1157 | + do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
1158 | + $this->loader->getShared('EE_Admin'); |
|
1159 | + } |
|
1160 | + do_action('AHEE__EE_System__load_controllers__complete'); |
|
1161 | + } |
|
1162 | + |
|
1163 | + |
|
1164 | + |
|
1165 | + /** |
|
1166 | + * core_loaded_and_ready |
|
1167 | + * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
1168 | + * |
|
1169 | + * @access public |
|
1170 | + * @return void |
|
1171 | + */ |
|
1172 | + public function core_loaded_and_ready() |
|
1173 | + { |
|
1174 | + if ( |
|
1175 | + $this->request->isAdmin() |
|
1176 | + || $this->request->isEeAjax() |
|
1177 | + || $this->request->isFrontend() |
|
1178 | + ) { |
|
1179 | + $this->loader->getShared('EE_Session'); |
|
1180 | + } |
|
1181 | + do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
1182 | + // load_espresso_template_tags |
|
1183 | + if ( |
|
1184 | + is_readable(EE_PUBLIC . 'template_tags.php') |
|
1185 | + && ( |
|
1186 | + $this->request->isFrontend() |
|
1187 | + || $this->request->isAdmin() |
|
1188 | + || $this->request->isIframe() |
|
1189 | + || $this->request->isFeed() |
|
1190 | + ) |
|
1191 | + ) { |
|
1192 | + require_once EE_PUBLIC . 'template_tags.php'; |
|
1193 | + } |
|
1194 | + do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
1195 | + if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) { |
|
1196 | + $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
1197 | + } |
|
1198 | + } |
|
1199 | + |
|
1200 | + |
|
1201 | + |
|
1202 | + /** |
|
1203 | + * initialize |
|
1204 | + * this is the best place to begin initializing client code |
|
1205 | + * |
|
1206 | + * @access public |
|
1207 | + * @return void |
|
1208 | + */ |
|
1209 | + public function initialize() |
|
1210 | + { |
|
1211 | + do_action('AHEE__EE_System__initialize'); |
|
1212 | + } |
|
1213 | + |
|
1214 | + |
|
1215 | + |
|
1216 | + /** |
|
1217 | + * initialize_last |
|
1218 | + * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
1219 | + * initialize has done so |
|
1220 | + * |
|
1221 | + * @access public |
|
1222 | + * @return void |
|
1223 | + */ |
|
1224 | + public function initialize_last() |
|
1225 | + { |
|
1226 | + do_action('AHEE__EE_System__initialize_last'); |
|
1227 | + add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
1228 | + } |
|
1229 | + |
|
1230 | + |
|
1231 | + |
|
1232 | + /** |
|
1233 | + * @return void |
|
1234 | + * @throws EE_Error |
|
1235 | + */ |
|
1236 | + public function addEspressoToolbar() |
|
1237 | + { |
|
1238 | + $this->loader->getShared( |
|
1239 | + 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
1240 | + array($this->registry->CAP) |
|
1241 | + ); |
|
1242 | + } |
|
1243 | + |
|
1244 | + |
|
1245 | + |
|
1246 | + /** |
|
1247 | + * do_not_cache |
|
1248 | + * sets no cache headers and defines no cache constants for WP plugins |
|
1249 | + * |
|
1250 | + * @access public |
|
1251 | + * @return void |
|
1252 | + */ |
|
1253 | + public static function do_not_cache() |
|
1254 | + { |
|
1255 | + // set no cache constants |
|
1256 | + if (! defined('DONOTCACHEPAGE')) { |
|
1257 | + define('DONOTCACHEPAGE', true); |
|
1258 | + } |
|
1259 | + if (! defined('DONOTCACHCEOBJECT')) { |
|
1260 | + define('DONOTCACHCEOBJECT', true); |
|
1261 | + } |
|
1262 | + if (! defined('DONOTCACHEDB')) { |
|
1263 | + define('DONOTCACHEDB', true); |
|
1264 | + } |
|
1265 | + // add no cache headers |
|
1266 | + add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
1267 | + // plus a little extra for nginx and Google Chrome |
|
1268 | + add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
1269 | + // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
1270 | + remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
1271 | + } |
|
1272 | + |
|
1273 | + |
|
1274 | + |
|
1275 | + /** |
|
1276 | + * extra_nocache_headers |
|
1277 | + * |
|
1278 | + * @access public |
|
1279 | + * @param $headers |
|
1280 | + * @return array |
|
1281 | + */ |
|
1282 | + public static function extra_nocache_headers($headers) |
|
1283 | + { |
|
1284 | + // for NGINX |
|
1285 | + $headers['X-Accel-Expires'] = 0; |
|
1286 | + // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
1287 | + $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
1288 | + return $headers; |
|
1289 | + } |
|
1290 | + |
|
1291 | + |
|
1292 | + |
|
1293 | + /** |
|
1294 | + * nocache_headers |
|
1295 | + * |
|
1296 | + * @access public |
|
1297 | + * @return void |
|
1298 | + */ |
|
1299 | + public static function nocache_headers() |
|
1300 | + { |
|
1301 | + nocache_headers(); |
|
1302 | + } |
|
1303 | + |
|
1304 | + |
|
1305 | + |
|
1306 | + /** |
|
1307 | + * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
1308 | + * never returned with the function. |
|
1309 | + * |
|
1310 | + * @param array $exclude_array any existing pages being excluded are in this array. |
|
1311 | + * @return array |
|
1312 | + */ |
|
1313 | + public function remove_pages_from_wp_list_pages($exclude_array) |
|
1314 | + { |
|
1315 | + return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
1316 | + } |
|
1317 | 1317 | |
1318 | 1318 | |
1319 | 1319 |