blob: ca2a32682ae762e9ec2711890d5f4c1a0fc74add (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
<?php
/**
* Database model for plugin assets
*
* @author Jan-Hendrik Willms <tleilax+studip@gmail.com>
* @license GPL2 or any later version
* @since Stud.IP 3.4
*/
class PluginAsset extends SimpleORMap
{
public const CACHE_DURATION = 2419200; // = 4 * 7 * 24 * 60 * 60 = 4 weeks
/**
* Configures the model
*
* @param Array $config Configuration array
*/
protected static function configure($config = [])
{
$config['db_table'] = 'plugin_assets';
parent::configure($config);
}
/**
* Store the asset's content. Currently, this will store
* to a file in the upload directory of Stud.IP.
*
* @param String $content Content of the asset
*/
public function writeContent($content)
{
$fp = $this->getFileHandle('w+');
fputs($fp, $content);
fclose($fp);
if (strlen($content) != $this->size) {
$this->size = strlen($content);
$this->store();
} else {
$this->triggerChdate();
}
}
/**
* Read the asset's content. Currently, this will read
* from a file in the upload directory of Stud.IP.
*
* @return String containing the asset's content
*/
public function readContent()
{
$fp = $this->getFileHandle('r');
$content = stream_get_contents($fp);
fclose($fp);
return $content;
}
/**
* Deletes the asset.
*
* @return int indicating how many rows were deleted
*/
public function delete()
{
$filename = $this->getFilepath();
if (file_exists($filename)) {
unlink($filename);
}
return parent::delete();
}
/**
* Obtain a file handle
*
* @param String $mode Valid file mode for fopen().
* @return Resource for the file
* @throws Exception when handle could not be obtained
*/
private function getFileHandle($mode)
{
$filename = $this->getFilepath();
$fp = fopen($filename, $mode);
if ($fp === false) {
throw new Exception('Could not obtain file handle');
}
return $fp;
}
/**
* Returns the path to the asset's file
*
* @return String containing the file path
* @throws Exception when the asset path is invalid or could not
* be created
*/
private function getFilepath()
{
if (!isset($GLOBALS['PLUGIN_ASSETS_PATH'])) {
throw new Exception(
'Configuration error: Path for assets is missing ' .
'(add "$PLUGIN_ASSETS_PATH = $STUDIP_BASE_PATH . \'/data/assets_cache\';" ' .
'to file "config/config_local.inc.php" ' .
'and be sure to have created this directory)'
);
}
$assets_path = $GLOBALS['PLUGIN_ASSETS_PATH'];
if (!is_dir($assets_path) || !is_writable($assets_path)) {
throw new Exception('Unable to access assets directory');
}
return $assets_path . '/' . $this->storagename;
}
}
|
