Skip to content
Snippets Groups Projects
Commit 95b2e08f authored by Tim Steiner's avatar Tim Steiner
Browse files

[gh-166] Merging from testing into staging

git-svn-id: file:///tmp/wdn_thm_drupal/branches/drupal-7.x/staging@810 20a16fea-79d4-4915-8869-1ea9d5ebf173
parent 84588aea
Branches
Tags
No related merge requests found
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave,
Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute
verbatim copies of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to
share and change it. By contrast, the GNU General Public License is
intended to guarantee your freedom to share and change free software--to
make sure the software is free for all its users. This General Public License
applies to most of the Free Software Foundation's software and to any other
program whose authors commit to using it. (Some other Free Software
Foundation software is covered by the GNU Library General Public License
instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our
General Public Licenses are designed to make sure that you have the
freedom to distribute copies of free software (and charge for this service if
you wish), that you receive source code or can get it if you want it, that you
can change the software or use pieces of it in new free programs; and that
you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to
deny you these rights or to ask you to surrender the rights. These restrictions
translate to certain responsibilities for you if you distribute copies of the
software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for
a fee, you must give the recipients all the rights that you have. You must make
sure that they, too, receive or can get the source code. And you must show
them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2)
offer you this license which gives you legal permission to copy, distribute
and/or modify the software.
Also, for each author's protection and ours, we want to make certain that
everyone understands that there is no warranty for this free software. If the
software is modified by someone else and passed on, we want its recipients
to know that what they have is not the original, so that any problems
introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We
wish to avoid the danger that redistributors of a free program will individually
obtain patent licenses, in effect making the program proprietary. To prevent
this, we have made it clear that any patent must be licensed for everyone's
free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification
follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
MODIFICATION
0. This License applies to any program or other work which contains a notice
placed by the copyright holder saying it may be distributed under the terms
of this General Public License. The "Program", below, refers to any such
program or work, and a "work based on the Program" means either the
Program or any derivative work under copyright law: that is to say, a work
containing the Program or a portion of it, either verbatim or with
modifications and/or translated into another language. (Hereinafter, translation
is included without limitation in the term "modification".) Each licensee is
addressed as "you".
Activities other than copying, distribution and modification are not covered
by this License; they are outside its scope. The act of running the Program is
not restricted, and the output from the Program is covered only if its contents
constitute a work based on the Program (independent of having been made
by running the Program). Whether that is true depends on what the Program
does.
1. You may copy and distribute verbatim copies of the Program's source
code as you receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice and
disclaimer of warranty; keep intact all the notices that refer to this License
and to the absence of any warranty; and give any other recipients of the
Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you
may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it,
thus forming a work based on the Program, and copy and distribute such
modifications or work under the terms of Section 1 above, provided that you
also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that
you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in
part contains or is derived from the Program or any part thereof, to be
licensed as a whole at no charge to all third parties under the terms of this
License.
c) If the modified program normally reads commands interactively when run,
you must cause it, when started running for such interactive use in the most
ordinary way, to print or display an announcement including an appropriate
copyright notice and a notice that there is no warranty (or else, saying that
you provide a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this License.
(Exception: if the Program itself is interactive but does not normally print such
an announcement, your work based on the Program is not required to print
an announcement.)
These requirements apply to the modified work as a whole. If identifiable
sections of that work are not derived from the Program, and can be
reasonably considered independent and separate works in themselves, then
this License, and its terms, do not apply to those sections when you distribute
them as separate works. But when you distribute the same sections as part
of a whole which is a work based on the Program, the distribution of the
whole must be on the terms of this License, whose permissions for other
licensees extend to the entire whole, and thus to each and every part
regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to
work written entirely by you; rather, the intent is to exercise the right to
control the distribution of derivative or collective works based on the
Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of a
storage or distribution medium does not bring the other work under the scope
of this License.
3. You may copy and distribute the Program (or a work based on it, under
Section 2) in object code or executable form under the terms of Sections 1
and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source
code, which must be distributed under the terms of Sections 1 and 2 above
on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give
any third party, for a charge no more than your cost of physically performing
source distribution, a complete machine-readable copy of the corresponding
source code, to be distributed under the terms of Sections 1 and 2 above on
a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute
corresponding source code. (This alternative is allowed only for
noncommercial distribution and only if you received the program in object
code or executable form with such an offer, in accord with Subsection b
above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source code
means all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation and
installation of the executable. However, as a special exception, the source
code distributed need not include anything that is normally distributed (in
either source or binary form) with the major components (compiler, kernel,
and so on) of the operating system on which the executable runs, unless that
component itself accompanies the executable.
If distribution of executable or object code is made by offering access to
copy from a designated place, then offering equivalent access to copy the
source code from the same place counts as distribution of the source code,
even though third parties are not compelled to copy the source along with the
object code.
4. You may not copy, modify, sublicense, or distribute the Program except as
expressly provided under this License. Any attempt otherwise to copy,
modify, sublicense or distribute the Program is void, and will automatically
terminate your rights under this License. However, parties who have received
copies, or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it.
However, nothing else grants you permission to modify or distribute the
Program or its derivative works. These actions are prohibited by law if you
do not accept this License. Therefore, by modifying or distributing the
Program (or any work based on the Program), you indicate your acceptance
of this License to do so, and all its terms and conditions for copying,
distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the original
licensor to copy, distribute or modify the Program subject to these terms and
conditions. You may not impose any further restrictions on the recipients'
exercise of the rights granted herein. You are not responsible for enforcing
compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues), conditions
are imposed on you (whether by court order, agreement or otherwise) that
contradict the conditions of this License, they do not excuse you from the
conditions of this License. If you cannot distribute so as to satisfy
simultaneously your obligations under this License and any other pertinent
obligations, then as a consequence you may not distribute the Program at all.
For example, if a patent license would not permit royalty-free redistribution
of the Program by all those who receive copies directly or indirectly through
you, then the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply and
the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or
other property right claims or to contest validity of any such claims; this
section has the sole purpose of protecting the integrity of the free software
distribution system, which is implemented by public license practices. Many
people have made generous contributions to the wide range of software
distributed through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing to
distribute software through any other system and a licensee cannot impose
that choice.
This section is intended to make thoroughly clear what is believed to be a
consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain
countries either by patents or by copyrighted interfaces, the original copyright
holder who places the Program under this License may add an explicit
geographical distribution limitation excluding those countries, so that
distribution is permitted only in or among countries not thus excluded. In such
case, this License incorporates the limitation as if written in the body of this
License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will be
similar in spirit to the present version, but may differ in detail to address new
problems or concerns.
Each version is given a distinguishing version number. If the Program specifies
a version number of this License which applies to it and "any later version",
you have the option of following the terms and conditions either of that
version or of any later version published by the Free Software Foundation. If
the Program does not specify a version number of this License, you may
choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs
whose distribution conditions are different, write to the author to ask for
permission. For software which is copyrighted by the Free Software
Foundation, write to the Free Software Foundation; we sometimes make
exceptions for this. Our decision will be guided by the two goals of
preserving the free status of all derivatives of our free software and of
promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE,
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT
PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR
AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE
PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA
OR DATA BEING RENDERED INACCURATE OR LOSSES
SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN
IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
This module provides integration between your Drupal site and the
Varnish HTTP Accelerator, an advanced and very fast reverse-proxy system.
Basically, Varnish handles serving static files and anonymous page-views
for your site much faster and at higher volumes than Apache,
in the neighborhood of 3000 requests per second.
## Installation
In order to install the module you need to do the following:
* Enable the module.
* Add something like this to your settings.php file:
// Add Varnish as the page cache handler.
$conf['cache_backends'] = array('sites/all/modules/varnish/varnish.cache.inc');
$conf['cache_class_cache_page'] = 'VarnishCache';
// Drupal 7 does not cache pages when we invoke hooks during bootstrap. This needs
// to be disabled.
$conf['page_cache_invoke_hooks'] = FALSE;
* Go to admin/config/development/varnish and configure your connection Varnish
appropriately. It should be pretty straight forward from here on.
## Running the simpletests for Varnish
In order to test the Varnish module, you need a "working" Varnish configuration that caches
pages for anonymous users. You also need to specify the variables that configures
your Varnish connection in your $conf array in your settings.php file.
\ No newline at end of file
<?php
/**
* @file
*
* Administrative functions for Varnish integration.
*/
/**
* Menu callback for varnish admin settings.
*/
function varnish_admin_settings_form() {
$form = array();
if (!extension_loaded('sockets')) {
drupal_set_message(t('<a href="http://php.net/manual/en/sockets.installation.php">PHP Sockets extension</a> not enabled. Varnish terminal communication configuration skipped.'), 'error');
return system_settings_form($form);
}
// Begin socket-dependent configuration.
// Decide whether or not to flush caches on cron runs.
$form['varnish_flush_cron'] = array(
'#type' => 'radios',
'#title' => t('Flush page cache on cron?'),
'#options' => array(
0 => t('Disabled'),
1 => t('Enabled (with respect for cache_lifetime)'),
),
'#default_value' => variable_get('varnish_flush_cron', 0),
'#description' => t('Internally Drupal will attempt to flush its page cache every time cron.php runs. This can mean too-frequent cache flushes if you have cron running frequently. NOTE: this cache flush is global!'),
);
$form['varnish_legacy'] = array(
'#type' => 'checkbox',
'#title' => t('Varnish Legacy Mode'),
'#default_value' => variable_get('varnish_legacy', 0),
'#description' => t('Check this if you use a version of varnish lower than 2.1'),
);
$form['varnish_control_terminal'] = array(
'#type' => 'textfield',
'#title' => t('Varnish Control Terminal'),
'#default_value' => variable_get('varnish_control_terminal', '127.0.0.1:6082'),
'#required' => TRUE,
'#description' => t('Set this to the server IP or hostname that varnish runs on (e.g. 127.0.0.1:6082). This must be configured for Drupal to talk to Varnish. Separate multiple servers with spaces.'),
);
$form['varnish_control_key'] = array(
'#type' => 'textfield',
'#title' => t('Varnish Control Key'),
'#default_value' => variable_get('varnish_control_key', ''),
'#description' => t('Optional: if you have established a secret key for control terminal access, please put it here.'),
);
$form['varnish_socket_timeout'] = array(
'#type' => 'textfield',
'#title' => t('Varnish connection timeout (milliseconds)'),
'#default_value' => variable_get('varnish_socket_timeout', VARNISH_DEFAULT_TIMETOUT),
'#description' => t('If Varnish is running on a different server, you may need to increase this value.'),
'#required' => TRUE,
);
$form['varnish_cache_clear'] = array(
'#type' => 'radios',
'#title' => t('Varnish Cache Clearing'),
'#options' => array(
VARNISH_DEFAULT_CLEAR => t('Drupal Default'),
VARNISH_NO_CLEAR => t('None'),
),
'#default_value' => variable_get('varnish_cache_clear', VARNISH_DEFAULT_CLEAR),
'#description' => t('What kind of cache clearing Varnish should utilize. Drupal default will clear all page caches on node updates and cache flush events. None will allow pages to persist for their full max-age; use this if you want to write your own cache-clearing logic.'),
);
// Detect expire module and add this option.
if (module_exists('expire')) {
$form['varnish_cache_clear']['#options'][VARNISH_SELECTIVE_CLEAR] = t('Selective (experimental; uses expire.module)');
$form['varnish_cache_clear']['#description'] .= ' ' . t('Selective will clear a list of URLs you specify as well as any node urls themselves.');
}
else {
$form['varnish_cache_clear']['#description'] .= ' ' . t('Installing the !link will enable "Selective" clearing.', array('!link' => '<a href="http://drupal.org/project/expire" target="_blank">' . t('Expire module') . '</a>'));
}
// Check status
$form['varnish_stats'] = array(
'#type' => 'item',
'#title' => t('Status'),
'#markup' => theme('varnish_status', varnish_get_status()),
);
return system_settings_form($form);
}
function varnish_admin_settings_form_validate($form, &$form_state) {
if (!is_numeric($form_state['values']['varnish_socket_timeout']) || $form_state['values']['varnish_socket_timeout'] < 0) {
form_set_error('varnish_socket_timeout', t('Varnish connection timeout must be a positive number.'));
}
else {
$form_state['values']['varnish_socket_timeout'] = (int) $form_state['values']['varnish_socket_timeout'];
}
}
/**
* Menu callback for varnish admin settings.
*/
function varnish_admin_reports_page() {
// Connect to varnish and do a full status report.
$status = _varnish_terminal_run(array('stats'));
$output = '';
foreach ($status as $terminal => $stat) {
$output .= '<pre>' . $stat['stats']['msg'] . '</pre>';
}
return $output;
}
<?php
/**
* @file
* Cache include file, to be used in settings.php file.
*/
/**
* Varnish cache implementation.
*
* This cache implementation can be used together with Varnish. You can't really
* use it to store or get any values, but you can use it to purge your caches.
* This cache implementation should ONLY be used for cache_page and no other
* cache bin!
*/
class VarnishCache implements DrupalCacheInterface {
protected $bin;
function __construct($bin) {
$this->bin = $bin;
}
function get($cid) {
return FALSE;
}
function getMultiple(&$cids) {
return array();
}
function set($cid, $data, $expire = CACHE_PERMANENT) {
// We won't do anything here.
}
function clear($cid = NULL, $wildcard = FALSE) {
global $user;
// Check that we really want to do a cache flush.
if (!module_exists('varnish') || variable_get('varnish_cache_clear', VARNISH_DEFAULT_CLEAR) != VARNISH_DEFAULT_CLEAR ||
(variable_get('varnish_flush_cron', 0) && lock_may_be_available('cron'))) {
return;
}
if (empty($cid)) {
if (variable_get('cache_lifetime', 0)) {
// We store the time in the current user's $user->cache variable which
// will be saved into the sessions bin by _drupal_session_write(). We then
// simulate that the cache was flushed for this user by not returning
// cached data that was cached before the timestamp.
$user->cache = REQUEST_TIME;
$cache_flush = variable_get('cache_flush_' . $this->bin, 0);
if ($cache_flush == 0) {
// This is the first request to clear the cache, start a timer.
variable_set('cache_flush_' . $this->bin, REQUEST_TIME);
}
elseif (REQUEST_TIME > ($cache_flush + variable_get('cache_lifetime', 0))) {
// Clear the cache for everyone, cache_lifetime seconds have
// passed since the first request to clear the cache.
varnish_purge_all_pages();
}
}
else {
// No minimum cache lifetime, flush all temporary cache entries now.
varnish_purge_all_pages();
}
}
else {
if ($wildcard) {
if ($cid == '*') {
varnish_purge_all_pages();
}
else {
$host = _varnish_get_host();
$base = base_path();
$purge = $cid . '(.*)';
_varnish_terminal_run(array('purge req.http.host ~ ' . $host . ' && req.url ~ "^' . $base . $purge . '$"'));
}
}
elseif (is_array($cid)) {
varnish_expire_cache($cid);
}
else {
varnish_expire_cache(array($cid));
}
}
}
function isEmpty() {
return FALSE;
}
}
<?php
/**
* @file
* This file contains drush integration for the varnish module.
*/
/**
* Implements hook_drush_command().
*/
function varnish_drush_command() {
$items = array();
$items['varnish-purge-all'] = array(
'description' => 'Purge all pages in varnish.',
'drupal dependencies' => array('varnish'),
'aliases' => array('vpa'),
'callback' => 'varnish_purge_all_pages',
);
$items['varnish-purge'] = array(
'description' => "Purge a list of URLs in varnish.",
'arguments' => array(
'paths' => 'A list of paths to purge separated by spaces. Regular expressions allowed.',
),
'aliases' => array('vp'),
'drupal dependencies' => array('varnish'),
'callback' => 'varnish_drush_purge'
);
return $items;
}
/**
* Callback for varnish-purge drush command.
* @param string $paths a space separated list of paths.
*/
function varnish_drush_purge($paths) {
$paths = explode(' ', $paths);
varnish_expire_cache($paths);
}
name = Varnish
description = "Provides integration with the Varnish HTTP accelerator."
core = 7.x
configure = admin/config/development/varnish
package = Caching
files[] = varnish.admin.inc
files[] = varnish.cache.inc
files[] = varnish.test
; Information added by drupal.org packaging script on 2011-06-12
version = "7.x-1.x-dev"
core = "7.x"
project = "varnish"
datestamp = "1307839269"
<?php
define('VARNISH_NO_CLEAR', 0);
define('VARNISH_DEFAULT_CLEAR', 1);
define('VARNISH_SELECTIVE_CLEAR', 2); // Requires Expire.module to be enabled.
define('VARNISH_DEFAULT_TIMETOUT', 100); // 100ms
define('VARNISH_SERVER_STATUS_DOWN', 0);
define('VARNISH_SERVER_STATUS_UP', 1);
/**
* @file
* varnish.module
* Provide drupal hooks for integration with the Varnish control layer.
*/
/**
* Implements hook_menu().
*
* Set up admin settings callbacks, etc.
*/
function varnish_menu() {
$items = array();
$items['admin/config/development/varnish'] = array(
'title' => 'Varnish',
'description' => 'Configure your varnish integration.',
'page callback' => 'drupal_get_form',
'page arguments' => array('varnish_admin_settings_form'),
'access arguments' => array('administer varnish'),
'file' => 'varnish.admin.inc',
);
$items['admin/config/development/varnish/general'] = array(
'title' => 'General',
'description' => 'Configure Varnish servers and cache invalidation settings',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -5,
);
$items['admin/reports/varnish'] = array(
'title' => 'Varnish status',
'description' => 'Get the output of varnishstat.',
'page callback' => 'varnish_admin_reports_page',
'access arguments' => array('administer varnish'),
'file' => 'varnish.admin.inc',
);
return $items;
}
/**
* Implements hook_theme().
*/
function varnish_theme() {
return array(
'varnish_status' => array(
'arguments' => array('status' => array()),
)
);
}
/**
* Implements hook_permisson().
*
* Adds administer Varnish permission.
*/
function varnish_permission() {
return array(
'administer varnish' => array(
'title' => t('Administer Varnish'),
'description' => t('Perform administration tasks for varnish.'),
),
);
}
/**
* Implements hook_requirements().
*
* Ensure that varnish's connection is good.
*/
function varnish_requirements($phase) {
if ($phase == 'runtime') {
$requirements = array('varnish');
$requirements['varnish']['title'] = t('Varnish status');
// try a varnish admin connect, report results
$status = _varnish_terminal_run(array('status'));
$terminals = explode(' ', variable_get('varnish_control_terminal', '127.0.0.1:6082'));
foreach ($terminals as $term) {
list($server, $port) = explode(':', $term);
$stat = array_shift($status);
if ($stat['status']['code'] === FALSE) {
$requirements['varnish']['value'] = t('Varnish connection broken');
$requirements['varnish']['severity'] = REQUIREMENT_ERROR;
$requirements['varnish']['description'] = t('The Varnish control terminal is not responding at %server on port %port.', array('%server' => $server, '%port' => $port));
return $requirements;
}
else {
$requirements['varnish']['value'] = t('Varnish running. Observe more detailed statistics !link.', array('!link' => l(t('here'), 'admin/reports/varnish')));
}
}
return $requirements;
}
}
/**
* Implements hook_expire_cache().
*
* Takes an array from expire.module and issue purges.
* You may also safely call this function directly with an array of local urls to purge.
*/
function varnish_expire_cache($paths) {
$host = _varnish_get_host();
$base = base_path();
$purge = implode('$|^' . $base, $paths);
_varnish_terminal_run(array('purge req.http.host ~ ' . $host . ' && req.url ~ "^' . $base . $purge . '$"'));
}
/**
* Helper function to quickly flush all caches for the current site.
*/
function varnish_purge_all_pages() {
$path = base_path();
$host = _varnish_get_host();
_varnish_terminal_run("purge req.http.host ~ $host && req.url ~ ^$path");
}
/**
* Get the status (up/down) of each of the varnish servers.
*
* @return An array of server statuses, keyed by varnish terminal addresses.
* The status will be a numeric constant, either:
* - VARNISH_SERVER_STATUS_UP
* - VARNISH_SERVER_STATUS_DOWN
*/
function varnish_get_status() {
// use a static-cache so this can be called repeatedly without incurring
// socket-connects for each call.
static $results = NULL;
if (is_null($results)) {
$results = array();
$status = _varnish_terminal_run(array('status'));
$terminals = explode(' ', variable_get('varnish_control_terminal', '127.0.0.1:6082'));
foreach ($terminals as $terminal) {
$stat = array_shift($status);
$results[$terminal] = ($stat['status']['code'] == 200) ? VARNISH_SERVER_STATUS_UP : VARNISH_SERVER_STATUS_DOWN;
}
}
return $results;
}
/**
* Theme handler for theme('varnish_status').
*/
function theme_varnish_status($status) {
$items = array();
foreach ($status as $terminal => $state) {
list($server, $port) = explode(':', $terminal);
if ($state == VARNISH_SERVER_STATUS_UP) {
$icon = theme('image', array('path' => 'misc/watchdog-ok.png', 'alt' => "Server OK: {$server}:{$port}", "{$server}:{$port}"));
$items[] = t('!status_icon Varnish running. Observe more detailed statistics !link.', array('!status_icon' => $icon, '!link' => l(t('here'), 'admin/reports/varnish')));
}
else {
$icon = theme('image', array('path' => 'misc/watchdog-error.png', 'alt' => 'Server down: {$server}:{$port}', "{$server}:{$port}"));
$items[] = t('!status_icon The Varnish control terminal is not responding at %server on port %port.', array('!status_icon' => $icon, '%server' => $server, '%port' => $port));
}
}
return theme('item_list', array('items' => $items));
}
/**
* Helper function to parse the host from the global $base_url
*/
function _varnish_get_host() {
global $base_url;
$parts = parse_url($base_url);
return $parts['host'];
}
/**
* Helper function that sends commands to Varnish.
* Utilizes sockets to talk to varnish terminal.
*/
function _varnish_terminal_run($commands) {
if (!extension_loaded('sockets')) {
// Prevent fatal errors if people don't have requirements.
return FALSE;
}
// Convert single commands to an array so we can handle everything in the same way.
if (!is_array($commands)) {
$commands = array($commands);
}
$ret = array();
$terminals = explode(' ', variable_get('varnish_control_terminal', '127.0.0.1:6082'));
$timeout = variable_get('varnish_socket_timeout', VARNISH_DEFAULT_TIMETOUT);
$seconds = (int)($timeout / 1000);
$milliseconds = (int)($timeout % 1000 * 1000);
foreach ($terminals as $terminal) {
list($server, $port) = explode(':', $terminal);
$client = socket_create(AF_INET, SOCK_STREAM, getprotobyname('tcp'));
socket_set_option($client, SOL_SOCKET, SO_SNDTIMEO, array('sec' => $seconds, 'usec' => $milliseconds));
socket_set_option($client, SOL_SOCKET, SO_RCVTIMEO, array('sec' => $seconds, 'usec' => $milliseconds));
if (@!socket_connect($client, $server, $port)) {
watchdog('varnish', 'Unable to connect to server socket !server:!port: %error', array(
'!server' => $server,
'!port' => $port,
'%error' => socket_strerror(socket_last_error($client))
), WATCHDOG_ERROR);
$ret[] = FALSE;
// If a varnish server is unavailable, move on to the next in the list.
continue;
}
// If there is a CLI banner message (varnish >= 2.1.x), try to read it and move on.
if (variable_get('varnish_legacy', 0) != 1) {
$status = _varnish_read_socket($client);
// Do we need to authenticate?
if ($status['code'] == 107) { // Require authentication
$secret = variable_get('varnish_control_key', '');
$challenge = substr($status['msg'], 0, 32);
$pack = $challenge . "\x0A" . $secret . "\x0A" . $challenge . "\x0A";
$key = hash('sha256', $pack);
socket_write($client, "auth $key\n");
$status = _varnish_read_socket($client);
if ($status['code'] != 200) {
watchdog('varnish', 'Authentication to server failed!', array(), WATCHDOG_ERROR);
}
}
}
foreach ($commands as $command) {
if ($status = _varnish_execute_command($client, $command)) {
$ret[$terminal][$command] = $status;
}
}
}
return $ret;
}
function _varnish_execute_command($client, $command) {
// Send command and get response.
$result = socket_write($client, "$command\n");
$status = _varnish_read_socket($client);
if ($status['code'] != 200) {
watchdog('varnish', 'Recieved status code !code running %command. Full response text: !error', array('!code' => $status['code'], '%command' => $command, '!error' => $status['msg']), WATCHDOG_ERROR);
return FALSE;
}
else {
// successful connection
return $status;
}
}
/**
* Low-level socket read function.
*
* @params
* $client an initialized socket client
*
* $retty how many times to retry on "temporarily unavalble" errors
*/
function _varnish_read_socket($client, $retry = 2) {
// Status and length info is always 13 characters.
$header = socket_read($client, 13, PHP_BINARY_READ);
if ($header == FALSE) {
$error = socket_last_error();
// 35 = socket-unavailable, so it might be blocked from our write.
// This is an acceptable place to retry.
if ($error == 35 && $retry > 0) {
return _varnish_read_socket($client, $retry-1);
}
else {
watchdog('varnish', 'Socket error: !error', array('!error' => socket_strerror($error)), WATCHDOG_ERROR);
return array(
'code' => $error,
'msg' => socket_strerror($error),
);
}
}
$msg_len = (int)substr($header, 4, 6) + 1;
$status = array(
'code' => substr($header, 0, 3),
'msg' => socket_read($client, $msg_len, PHP_BINARY_READ)
);
return $status;
}
<?php
/**
* @file
* Tests the basic functionality of Varnish.
*/
/**
* Base class for Varnish Test Cases.
*/
class VarnishTestCase extends DrupalWebTestCase {
function setUp() {
// Save off varnish settings, we will need to set these later
// on in order to perform tests.
parent::setUp('varnish', 'system_test');
$this->setUpVariables();
}
/**
* Set up variables so that drupal sends out appropriate headers
* to Varnish.
*/
function setUpVariables() {
$variables = array(
'cache' => 1,
'cache_lifetime' => 0,
'page_cache_maximum_age' => 1800,
);
foreach ($variables as $key => $variable) {
variable_set($key, $variable);
}
$this->refreshVariables();
}
/**
* Run a varnish command and make sure it worked for us.
* @param string $cmd the command to execute.
*/
function assertVarnishCommand($cmds) {
$statuses = _varnish_terminal_run($cmds);
foreach ($statuses as $terminal => $commands) {
foreach ($commands as $command => $status) {
$this->assertEqual($status['code'], '200', t('Command: %command
was executed properly.', array('%command' => $command)));
}
}
}
}
/**
* Test Varnish Connection.
*/
class VarnishConnectionTestCase extends VarnishTestCase {
public static function getInfo() {
return array(
'name' => 'Varnish Connection',
'description' => 'Test Communication between varnish admin terminal and Drupal.',
'group' => 'Varnish'
);
}
function testVarnishStatus() {
$this->assertVarnishCommand(array('status'));
}
function testVarnishStats() {
$this->assertVarnishCommand(array('stats'));
}
function testMultipleCommands() {
$this->assertVarnishCommand(array('stats', 'status'));
}
}
class VarnishCacheInvalidationCase extends VarnishTestCase {
public static function getInfo() {
return array(
'name' => 'Varnish Cache Expiration',
'description' => 'Tests Cache Expiration.',
'group' => 'Varnish'
);
}
function setUp() {
parent::setUp();
// Expire all cached pages.
varnish_purge_all_pages();
}
function assertRegexpPattern($content, $pattern, $message = '') {
$this->assertTrue(preg_match($pattern, $content), $message);
}
/**
* Test that makes sure that the varnish cache get's invalidated
* at the appropriate times.
*/
function testVarnishCacheExpiration() {
$not_cached_pattern = '/[0-9]{8,9}$/';
$cached_pattern = '/[0-9]{8,9} [0-9]{8,9}$/';
// Tell the Varnish module that it is OK to cache.
variable_set('varnish_cache_clear', 1);
// Fill the cache.
$this->drupalGet('system-test/set-header', array('query' => array('name' => 'Foo', 'value' => 'bar')));
$this->assertRegexpPattern($this->drupalGetHeader('X-Varnish'), $not_cached_pattern, t('Varnish header is indicating that it did not have this page in the cache.'));
// Request the page again. It should be in the cache.
$this->drupalGet('system-test/set-header', array('query' => array('name' => 'Foo', 'value' => 'bar')));
$this->assertRegexpPattern($this->drupalGetHeader('X-Varnish'), $cached_pattern , t('Varnish header is indicating that it had the page in the cache.'));
$headers = $this->drupalGetHeaders(TRUE);
// Clear the cache_page bin. This should trigger an invalidation of the page in Varnish.
cache_clear_all(NULL, 'cache_page');
$this->drupalGet('system-test/set-header', array('query' => array('name' => 'Foo', 'value' => 'bar')));
$this->assertRegexpPattern($this->drupalGetHeader('X-Varnish'), $not_cached_pattern , t('Varnish header is indicating that it did not have the page in the cache after a cache purge.'));
// Tell the Varnish module to not invalidate any pages in Varnish.
variable_set('varnish_cache_clear', 0);
cache_clear_all(NULL, 'cache_page');
$this->drupalGet('system-test/set-header', array('query' => array('name' => 'Foo', 'value' => 'bar')));
$this->assertRegexpPattern($this->drupalGetHeader('X-Varnish'), $cached_pattern , t('Varnish header is indicating that it had the page in the cache, even after a cache clear'));
// Set a minimum cache lifetime for the cache to avoid having varnish purging the cache.
variable_set('cache_lifetime', 3600);
// Cache the page.
$this->drupalGet('system-test/set-header', array('query' => array('name' => 'Foo', 'value' => 'bar')));
// Try to invalidate the cache, it should fail.
cache_clear_all(NULL, 'cache_page');
$this->drupalGet('system-test/set-header', array('query' => array('name' => 'Foo', 'value' => 'bar')));
$this->assertRegexpPattern($this->drupalGetHeader('X-Varnish'), $cached_pattern , t('Varnish cache did not invalidate itself when minimum cache lifetime was set.'));
}
}
class VarnishAdminTestCase extends VarnishTestCase {
var $admin_user;
public static function getInfo() {
return array(
'name' => 'Varnish Administration',
'description' => 'Tests Varnish Administration.',
'group' => 'Varnish'
);
}
function setUp() {
parent::setUp();
// Create a user that can administrate varnish.
$permissions = array(
'administer varnish',
'access administration pages',
'administer site configuration',
'access content',
);
$this->admin_user = $this->drupalCreateUser($permissions);
}
function testVarnishSettingsPage() {
$this->drupalLogin($this->admin_user);
$this->drupalGet('admin/config/development/varnish');
$values = $this->_getVarnishSettingsValues();
// Try to set the timeout value to something else than a numeric value.
// This should result in an error.
$values['varnish_socket_timeout'] = 'asdf';
$this->drupalPost('admin/config/development/varnish', $values, t('Save configuration'));
$this->assertText(t('Varnish connection timeout must be a positive number.'),
t('Error message was given trying to set timeout to a string.'));
}
function _getVarnishSettingsValues() {
return array(
'varnish_control_terminal' => variable_get('varnish_control_terminal', '127.0.0.1:6082'),
'varnish_flush_cron' => variable_get('varnish_flush_cron', 0),
'varnish_legacy' => variable_get('varnish_legacy', 0),
'varnish_control_key' => variable_get('varnish_control_key', 0),
'varnish_socket_timeout' => variable_get('varnish_socket_timeout', 100),
'varnish_cache_clear' => variable_get('varnish_cache_clear', 0),
);
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment