#692044: cache page metadata to improve performance of the statistics module in the cached workflow. From: Damien Tournoud --- bootstrap.inc | 55 +++++++++++++++++++++++++++++++++++++----- cache-install.inc | 2 +- cache.inc | 20 +++++---------- common.inc | 16 ++++++++---- path.inc | 42 -------------------------------- statistics/statistics.module | 2 -- system/system.install | 15 ++++++++--- update/update.install | 7 +++++ update/update.module | 4 --- 9 files changed, 83 insertions(+), 80 deletions(-) diff --git includes/bootstrap.inc includes/bootstrap.inc index 96247ba..16e37c5 100644 --- includes/bootstrap.inc +++ includes/bootstrap.inc @@ -1069,14 +1069,14 @@ function drupal_serve_page_from_cache(stdClass $cache) { // drupal_add_http_headers(). Keys are mixed-case. $default_headers = array(); - foreach ($cache->headers as $name => $value) { + foreach ($cache->data['headers'] as $name => $value) { // In the case of a 304 response, certain headers must be sent, and the // remaining may not (see RFC 2616, section 10.3.5). Do not override // headers set in hook_boot(). $name_lower = strtolower($name); if (in_array($name_lower, array('content-location', 'expires', 'cache-control', 'vary')) && !isset($hook_boot_headers[$name_lower])) { drupal_add_http_header($name, $value); - unset($cache->headers[$name]); + unset($cache->data['headers'][$name]); } } @@ -1106,7 +1106,7 @@ function drupal_serve_page_from_cache(stdClass $cache) { } // Send the remaining headers. - foreach ($cache->headers as $name => $value) { + foreach ($cache->data['headers'] as $name => $value) { drupal_add_http_header($name, $value); } @@ -1134,7 +1134,7 @@ function drupal_serve_page_from_cache(stdClass $cache) { header('Vary: Accept-Encoding', FALSE); // If page_compression is enabled, the cache contains gzipped data. if ($return_compressed) { - // $cache->data is already gzip'ed, so make sure zlib.output_compression + // $cache->data['body'] is already gzip'ed, so make sure zlib.output_compression // does not compress it once more. ini_set('zlib.output_compression', '0'); header('Content-Encoding: gzip'); @@ -1142,11 +1142,12 @@ function drupal_serve_page_from_cache(stdClass $cache) { else { // The client does not support compression, so unzip the data in the // cache. Strip the gzip header and run uncompress. - $cache->data = gzinflate(substr(substr($cache->data, 10), 0, -8)); + $cache->data['body'] = gzinflate(substr(substr($cache->data['body'], 10), 0, -8)); } } - print $cache->data; + // Print the page. + print $cache->data['body']; } /** @@ -1639,6 +1640,48 @@ function drupal_get_messages($type = NULL, $clear_queue = TRUE) { } /** + * Get the title of the current page, for display on the page and in the title bar. + * + * @return + * The current page's title. + */ +function drupal_get_title() { + $title = drupal_set_title(); + + // During a bootstrap, menu.inc is not included and thus we cannot provide a title. + if (!isset($title) && function_exists('menu_get_active_title')) { + $title = check_plain(menu_get_active_title()); + } + + return $title; +} + +/** + * Set the title of the current page, for display on the page and in the title bar. + * + * @param $title + * Optional string value to assign to the page title; or if set to NULL + * (default), leaves the current title unchanged. + * @param $output + * Optional flag - normally should be left as CHECK_PLAIN. Only set to + * PASS_THROUGH if you have already removed any possibly dangerous code + * from $title using a function like check_plain() or filter_xss(). With this + * flag the string will be passed through unchanged. + * + * @return + * The updated title of the current page. + */ +function drupal_set_title($title = NULL, $output = CHECK_PLAIN) { + $stored_title = &drupal_static(__FUNCTION__); + + if (isset($title)) { + $stored_title = ($output == PASS_THROUGH) ? $title : check_plain($title); + } + + return $stored_title; +} + +/** * Check to see if an IP address has been blocked. * * Blocked IP addresses are stored in the database by default. However for diff --git includes/cache-install.inc includes/cache-install.inc index 3beebf3..15dc38a 100644 --- includes/cache-install.inc +++ includes/cache-install.inc @@ -24,7 +24,7 @@ class DrupalFakeCache extends DrupalDatabaseCache implements DrupalCacheInterfac return array(); } - function set($cid, $data, $expire = CACHE_PERMANENT, array $headers = NULL) { + function set($cid, $data, $expire = CACHE_PERMANENT) { } function clear($cid = NULL, $wildcard = FALSE) { diff --git includes/cache.inc includes/cache.inc index b5dc86e..33057a0 100644 --- includes/cache.inc +++ includes/cache.inc @@ -133,11 +133,9 @@ function cache_get_multiple(array &$cids, $bin = 'cache') { * general cache wipe. * - A Unix timestamp: Indicates that the item should be kept at least until * the given time, after which it behaves like CACHE_TEMPORARY. - * @param $headers - * A string containing HTTP header information for cached pages. */ -function cache_set($cid, $data, $bin = 'cache', $expire = CACHE_PERMANENT, array $headers = NULL) { - return _cache_get_object($bin)->set($cid, $data, $expire, $headers); +function cache_set($cid, $data, $bin = 'cache', $expire = CACHE_PERMANENT) { + return _cache_get_object($bin)->set($cid, $data, $expire); } /** @@ -263,10 +261,8 @@ interface DrupalCacheInterface { * general cache wipe. * - A Unix timestamp: Indicates that the item should be kept at least until * the given time, after which it behaves like CACHE_TEMPORARY. - * @param $headers - * A string containing HTTP header information for cached pages. */ - function set($cid, $data, $expire = CACHE_PERMANENT, array $headers = NULL); + function set($cid, $data, $expire = CACHE_PERMANENT); /** @@ -312,7 +308,7 @@ class DrupalDatabaseCache implements DrupalCacheInterface { try { // Garbage collection necessary when enforcing a minimum cache lifetime. $this->garbageCollection($this->bin); - $cache = db_query("SELECT data, created, headers, expire, serialized FROM {" . $this->bin . "} WHERE cid = :cid", array(':cid' => $cid))->fetchObject(); + $cache = db_query("SELECT data, created, expire, serialized FROM {" . $this->bin . "} WHERE cid = :cid", array(':cid' => $cid))->fetchObject(); return $this->prepareItem($cache); } catch (Exception $e) { @@ -327,7 +323,7 @@ class DrupalDatabaseCache implements DrupalCacheInterface { // Garbage collection necessary when enforcing a minimum cache lifetime. $this->garbageCollection($this->bin); $query = db_select($this->bin); - $query->fields($this->bin, array('cid', 'data', 'created', 'headers', 'expire', 'serialized')); + $query->fields($this->bin, array('cid', 'data', 'created', 'expire', 'serialized')); $query->condition($this->bin . '.cid', $cids, 'IN'); $result = $query->execute(); $cache = array(); @@ -401,19 +397,15 @@ class DrupalDatabaseCache implements DrupalCacheInterface { if ($cache->serialized) { $cache->data = unserialize($cache->data); } - if (isset($cache->headers)) { - $cache->headers = unserialize($cache->headers); - } return $cache; } - function set($cid, $data, $expire = CACHE_PERMANENT, array $headers = NULL) { + function set($cid, $data, $expire = CACHE_PERMANENT) { $fields = array( 'serialized' => 0, 'created' => REQUEST_TIME, 'expire' => $expire, - 'headers' => isset($headers) ? serialize($headers) : NULL, ); if (!is_string($data)) { $fields['data'] = serialize($data); diff --git includes/common.inc includes/common.inc index c949efb..8442629 100644 --- includes/common.inc +++ includes/common.inc @@ -4518,28 +4518,32 @@ function drupal_page_set_cache() { if (drupal_page_is_cacheable()) { $cache = (object) array( 'cid' => $base_root . request_uri(), - 'data' => ob_get_clean(), + 'data' => array( + 'path' => $_GET['q'], + 'body' => ob_get_clean(), + 'title' => drupal_get_title(), + 'headers' => array(), + ), 'expire' => CACHE_TEMPORARY, 'created' => REQUEST_TIME, - 'headers' => array(), ); // Restore preferred header names based on the lower-case names returned // by drupal_get_http_header(). $header_names = _drupal_set_preferred_header_name(); foreach (drupal_get_http_header() as $name_lower => $value) { - $cache->headers[$header_names[$name_lower]] = $value; + $cache->data['headers'][$header_names[$name_lower]] = $value; if ($name_lower == 'expires') { // Use the actual timestamp from an Expires header if available. $cache->expire = strtotime($value); } } - if ($cache->data) { + if ($cache->data['body']) { if (variable_get('page_compression', TRUE) && extension_loaded('zlib')) { - $cache->data = gzencode($cache->data, 9, FORCE_GZIP); + $cache->data['body'] = gzencode($cache->data['body'], 9, FORCE_GZIP); } - cache_set($cache->cid, $cache->data, 'cache_page', $cache->expire, $cache->headers); + cache_set($cache->cid, $cache->data, 'cache_page', $cache->expire); } return $cache; } diff --git includes/path.inc includes/path.inc index 1f4d355..1e637f6 100644 --- includes/path.inc +++ includes/path.inc @@ -283,48 +283,6 @@ function arg($index = NULL, $path = NULL) { } /** - * Get the title of the current page, for display on the page and in the title bar. - * - * @return - * The current page's title. - */ -function drupal_get_title() { - $title = drupal_set_title(); - - // During a bootstrap, menu.inc is not included and thus we cannot provide a title. - if (!isset($title) && function_exists('menu_get_active_title')) { - $title = check_plain(menu_get_active_title()); - } - - return $title; -} - -/** - * Set the title of the current page, for display on the page and in the title bar. - * - * @param $title - * Optional string value to assign to the page title; or if set to NULL - * (default), leaves the current title unchanged. - * @param $output - * Optional flag - normally should be left as CHECK_PLAIN. Only set to - * PASS_THROUGH if you have already removed any possibly dangerous code - * from $title using a function like check_plain() or filter_xss(). With this - * flag the string will be passed through unchanged. - * - * @return - * The updated title of the current page. - */ -function drupal_set_title($title = NULL, $output = CHECK_PLAIN) { - $stored_title = &drupal_static(__FUNCTION__); - - if (isset($title)) { - $stored_title = ($output == PASS_THROUGH) ? $title : check_plain($title); - } - - return $stored_title; -} - -/** * Check if the current page is the front page. * * @return diff --git modules/statistics/statistics.module modules/statistics/statistics.module index ed7f630..036eaa9 100644 --- modules/statistics/statistics.module +++ modules/statistics/statistics.module @@ -51,8 +51,6 @@ function statistics_help($path, $arg) { function statistics_exit() { global $user; - drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL); - if (variable_get('statistics_count_content_views', 0)) { // We are counting content views. if ((arg(0) == 'node') && is_numeric(arg(1)) && arg(2) == '') { diff --git modules/system/system.install modules/system/system.install index be64f02..a135c4c 100644 --- modules/system/system.install +++ modules/system/system.install @@ -634,11 +634,6 @@ function system_schema() { 'not null' => TRUE, 'default' => 0, ), - 'headers' => array( - 'description' => 'Any custom HTTP headers to be added to cached data.', - 'type' => 'text', - 'not null' => FALSE, - ), 'serialized' => array( 'description' => 'A flag to indicate whether content is serialized (1) or not (0).', 'type' => 'int', @@ -2382,6 +2377,16 @@ function system_update_7053() { } /** + * Remove {cache_*}.headers columns. + */ +function system_update_7054() { + $cache_tables = array('cache', 'cache_bootstrap', 'cache_filter', 'cache_form', 'cache_menu', 'cache_page', 'cache_path'); + foreach ($cache_tables as $table) { + db_drop_field($table, 'headers'); + } +} + +/** * @} End of "defgroup updates-6.x-to-7.x" * The next series of updates should start at 8000. */ diff --git modules/update/update.install modules/update/update.install index 50a68eb..cd797a0 100644 --- modules/update/update.install +++ modules/update/update.install @@ -167,3 +167,10 @@ function update_update_7000() { $queue = DrupalQueue::get('update_fetch_tasks'); $queue->createQueue(); } + +/** + * Remove {cache_update}.headers columns. + */ +function update_update_7001() { + db_drop_field('cache_update', 'headers'); +} \ No newline at end of file diff --git modules/update/update.module modules/update/update.module index 36da9d0..ce15f36 100644 --- modules/update/update.module +++ modules/update/update.module @@ -653,9 +653,6 @@ function theme_update_last_check($variables) { /** * Store data in the private update status cache table. * - * Note: this function completely ignores the {cache_update}.headers field - * since that is meaningless for the kinds of data we're caching. - * * @param $cid * The cache ID to save the data with. * @param $data @@ -671,7 +668,6 @@ function _update_cache_set($cid, $data, $expire) { $fields = array( 'created' => REQUEST_TIME, 'expire' => $expire, - 'headers' => NULL, ); if (!is_string($data)) { $fields['data'] = serialize($data);