blob: fb8df03a7efe3956c57c1c0dc05a50a63af17c46 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Greg Akerbde25d92010-12-21 09:31:21 -06002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Greg Akerbde25d92010-12-21 09:31:21 -06006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreev7d4ea072011-12-25 19:23:50 +02008 *
Andrey Andreev125ef472016-01-11 12:33:00 +02009 * Copyright (c) 2014 - 2016, British Columbia Institute of Technology
Andrey Andreev7d4ea072011-12-25 19:23:50 +020010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Derek Jonesf4a4bd82011-10-20 12:18:42 -050017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
Andrey Andreev1924e872016-01-11 12:55:34 +020031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
Andrey Andreev125ef472016-01-11 12:33:00 +020032 * @copyright Copyright (c) 2014 - 2016, British Columbia Institute of Technology (http://bcit.ca/)
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020033 * @license http://opensource.org/licenses/MIT MIT License
Andrey Andreevbd202c92016-01-11 12:50:18 +020034 * @link https://codeigniter.com
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020035 * @since Version 2.0.0
Andrey Andreev7d4ea072011-12-25 19:23:50 +020036 * @filesource
Greg Akerbde25d92010-12-21 09:31:21 -060037 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Greg Akerbde25d92010-12-21 09:31:21 -060039
Greg Akerbde25d92010-12-21 09:31:21 -060040/**
Andrey Andreev7d4ea072011-12-25 19:23:50 +020041 * CodeIgniter APC Caching Class
Greg Akerbde25d92010-12-21 09:31:21 -060042 *
43 * @package CodeIgniter
44 * @subpackage Libraries
45 * @category Core
Derek Jonesf4a4bd82011-10-20 12:18:42 -050046 * @author EllisLab Dev Team
Andrey Andreev7d4ea072011-12-25 19:23:50 +020047 * @link
Greg Akerbde25d92010-12-21 09:31:21 -060048 */
Phil Sturgeoneb2dcda2011-04-02 14:44:58 +010049class CI_Cache_apc extends CI_Driver {
Greg Akerbde25d92010-12-21 09:31:21 -060050
51 /**
Andrey Andreev1be89872016-03-11 18:12:57 +020052 * Class constructor
53 *
54 * Only present so that an error message is logged
55 * if APC is not available.
56 *
57 * @return void
58 */
59 public function __construct()
60 {
61 if ( ! $this->is_supported())
62 {
63 log_message('error', 'Cache: Failed to initialize APC; extension not loaded/enabled?');
64 }
65 }
66
67 // ------------------------------------------------------------------------
68
69 /**
Andrey Andreev7d4ea072011-12-25 19:23:50 +020070 * Get
Greg Akerbde25d92010-12-21 09:31:21 -060071 *
Andrey Andreevb24b0332012-03-26 15:34:39 +030072 * Look for a value in the cache. If it exists, return the data
Greg Akerbde25d92010-12-21 09:31:21 -060073 * if not, return FALSE
74 *
Andrey Andreevb24b0332012-03-26 15:34:39 +030075 * @param string
76 * @return mixed value that is stored/FALSE on failure
Greg Akerbde25d92010-12-21 09:31:21 -060077 */
78 public function get($id)
79 {
Andrey Andreeva2b06772012-11-20 15:09:46 +020080 $success = FALSE;
81 $data = apc_fetch($id, $success);
Greg Akerbde25d92010-12-21 09:31:21 -060082
Andrey Andreev43d7fa72014-01-09 17:29:45 +020083 if ($success === TRUE)
84 {
85 return is_array($data)
86 ? unserialize($data[0])
87 : $data;
88 }
89
90 return FALSE;
Greg Akerbde25d92010-12-21 09:31:21 -060091 }
92
Andrey Andreev7d4ea072011-12-25 19:23:50 +020093 // ------------------------------------------------------------------------
94
Greg Akerbde25d92010-12-21 09:31:21 -060095 /**
96 * Cache Save
97 *
Andrey Andreev43d7fa72014-01-09 17:29:45 +020098 * @param string $id Cache ID
99 * @param mixed $data Data to store
Andrey Andreeve13fa9f2016-05-20 17:30:07 +0300100 * @param int $ttl Length of time (in seconds) to cache the data
Andrey Andreev43d7fa72014-01-09 17:29:45 +0200101 * @param bool $raw Whether to store the raw value
102 * @return bool TRUE on success, FALSE on failure
Greg Akerbde25d92010-12-21 09:31:21 -0600103 */
Andrey Andreev43d7fa72014-01-09 17:29:45 +0200104 public function save($id, $data, $ttl = 60, $raw = FALSE)
Greg Akerbde25d92010-12-21 09:31:21 -0600105 {
Sean Fisher7bb95df2012-01-16 09:23:14 -0500106 $ttl = (int) $ttl;
Andrey Andreev43d7fa72014-01-09 17:29:45 +0200107
108 return apc_store(
109 $id,
110 ($raw === TRUE ? $data : array(serialize($data), time(), $ttl)),
111 $ttl
112 );
Greg Akerbde25d92010-12-21 09:31:21 -0600113 }
Andrey Andreev7d4ea072011-12-25 19:23:50 +0200114
Greg Akerbde25d92010-12-21 09:31:21 -0600115 // ------------------------------------------------------------------------
116
117 /**
118 * Delete from Cache
119 *
Andrey Andreevb24b0332012-03-26 15:34:39 +0300120 * @param mixed unique identifier of the item in the cache
Timothy Warren0688ac92012-04-20 10:25:04 -0400121 * @return bool true on success/false on failure
Greg Akerbde25d92010-12-21 09:31:21 -0600122 */
123 public function delete($id)
124 {
125 return apc_delete($id);
126 }
127
128 // ------------------------------------------------------------------------
129
130 /**
Andrey Andreev43d7fa72014-01-09 17:29:45 +0200131 * Increment a raw value
132 *
133 * @param string $id Cache ID
134 * @param int $offset Step/value to add
135 * @return mixed New value on success or FALSE on failure
136 */
137 public function increment($id, $offset = 1)
138 {
139 return apc_inc($id, $offset);
140 }
141
142 // ------------------------------------------------------------------------
143
144 /**
145 * Decrement a raw value
146 *
147 * @param string $id Cache ID
148 * @param int $offset Step/value to reduce by
149 * @return mixed New value on success or FALSE on failure
150 */
151 public function decrement($id, $offset = 1)
152 {
153 return apc_dec($id, $offset);
154 }
155
156 // ------------------------------------------------------------------------
157
158 /**
Greg Akerbde25d92010-12-21 09:31:21 -0600159 * Clean the cache
160 *
Andrey Andreevb24b0332012-03-26 15:34:39 +0300161 * @return bool false on failure/true on success
Greg Akerbde25d92010-12-21 09:31:21 -0600162 */
163 public function clean()
164 {
165 return apc_clear_cache('user');
166 }
167
168 // ------------------------------------------------------------------------
169
170 /**
171 * Cache Info
172 *
Andrey Andreevb24b0332012-03-26 15:34:39 +0300173 * @param string user/filehits
174 * @return mixed array on success, false on failure
Greg Akerbde25d92010-12-21 09:31:21 -0600175 */
176 public function cache_info($type = NULL)
177 {
178 return apc_cache_info($type);
179 }
180
181 // ------------------------------------------------------------------------
182
183 /**
184 * Get Cache Metadata
185 *
Andrey Andreevb24b0332012-03-26 15:34:39 +0300186 * @param mixed key to get cache metadata on
187 * @return mixed array on success/false on failure
Greg Akerbde25d92010-12-21 09:31:21 -0600188 */
189 public function get_metadata($id)
190 {
Andrey Andreeva2b06772012-11-20 15:09:46 +0200191 $success = FALSE;
192 $stored = apc_fetch($id, $success);
Greg Akerbde25d92010-12-21 09:31:21 -0600193
Andrey Andreeva2b06772012-11-20 15:09:46 +0200194 if ($success === FALSE OR count($stored) !== 3)
Greg Akerbde25d92010-12-21 09:31:21 -0600195 {
196 return FALSE;
197 }
198
Greg Aker999e7472011-01-29 16:16:58 -0600199 list($data, $time, $ttl) = $stored;
Greg Akerbde25d92010-12-21 09:31:21 -0600200
201 return array(
202 'expire' => $time + $ttl,
203 'mtime' => $time,
Andrey Andreeva2b06772012-11-20 15:09:46 +0200204 'data' => unserialize($data)
Greg Akerbde25d92010-12-21 09:31:21 -0600205 );
206 }
207
208 // ------------------------------------------------------------------------
209
210 /**
211 * is_supported()
212 *
213 * Check to see if APC is available on this system, bail if it isn't.
Andrey Andreevb24b0332012-03-26 15:34:39 +0300214 *
215 * @return bool
Greg Akerbde25d92010-12-21 09:31:21 -0600216 */
217 public function is_supported()
218 {
Andrey Andreev1be89872016-03-11 18:12:57 +0200219 return (extension_loaded('apc') && ini_get('apc.enabled'));
Greg Akerbde25d92010-12-21 09:31:21 -0600220 }
Greg Akerbde25d92010-12-21 09:31:21 -0600221}