File: ForumML_FileStorage.class.php

package info (click to toggle)
fusionforge 5.3.2%2B20141104-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 60,472 kB
  • sloc: php: 271,846; sql: 36,817; python: 14,575; perl: 6,406; sh: 5,980; xml: 4,294; pascal: 1,411; makefile: 911; cpp: 52; awk: 27
file content (142 lines) | stat: -rw-r--r-- 4,708 bytes parent folder | download | duplicates (4)
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<?php
/**
 * Copyright (c) STMicroelectronics, 2007. All Rights Reserved.
 *
 * Originally written by Mohamed CHAARI, 2007
 *
 * This file is a part of codendi.
 *
 * codendi is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * codendi is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * $Id$
 */

/**
 * A class to handle mails attachments storage
 *
 */
class ForumML_FileStorage {

    // Root directory to host mails attachments
	var $root;

    /**
     * ForumML_FileStorage Constructor
     *
     * @param root: The ForumML attachments directory
     */
    function __construct($root) {
        $this->root = $root;
    }

    /**
     * Store - stores attached files in the ForumML root dir
     *
     * @param filename: name of attached file
     * @param content: content of attached file
     * @param list: mailing-list name
     * @param date: date of attachment in YYYY_MM_DD format
     * @param encod: encoding of attachment
     *
     * @return int size of attached file
     */
    function store($filename, $content, $list, $date, $encod="") {
        $path = $this->_getPath($filename, $list, $date, "store");
        $ret = file_put_contents($path, $content);
        if ($ret !== false) {
            return $path;
        } else {
            return false;
        }
    }

    /**
    * Store:
    *  +---------------------------------------------------------------------------------+
    *  |                             +-----------------------------------------+         |
    *  |                             |                                         |         |
    * _|__              _______     _|__                                       |         |
    * name              list_id     date                                       v         v
    * Attach.doc           7      2007_10_19              =>  foruuml_dir/<listname>/2007_10_19/Attach_doc
    *                      |                                              ^
    *                      +---------------------------------------------+|
    *
    *
    * Upload (to temporary location):
    *  +-----------------------------------------------------------------------+
    *  |                                                                       |
    *  |                                                                       |
    * _|__                                                                     |
    * name                                                                     v
    * Attach.doc                                     =>  foruuml_dir/upload/Attach_doc
    *
    */

    /**
     * _getPath - Get the absolute path where to Upload/Store attached file
     *
     * @param name: basename of attached file
     * @param list: mailing-list name
     * @param date: attachment date (YYYY_MM_DD)
     * @param string type: upload/store
     *
     * @return string path
     */
    function _getPath($name, $list, $date, $type) {
        $name = trim($name);

        if (trim($name) == '') {
            $name = 'attachment';
        } else {
            $name = mb_convert_encoding($name, 'ascii', 'utf-8');
            // restrict file name to 64 characters (maximum)
            if (strlen($name) > 64) {
                $name = substr($name, 0, 64);
            }

            $name = preg_replace('`[^a-z0-9_-]`i', '_', $name);
            $name = preg_replace('`_{2,}`', '_', $name);
        }

        if ($type == "upload") {
        	$path_elements = array($this->root, $type);
        } elseif ($type == "store") {
        	$path_elements = array($this->root, $list, $date);
        }

        $path = '';
        foreach($path_elements as $elem) {
            $path .= $elem .'/';
            if (!is_dir($path)) {
                mkdir($path, 0755);
            }
        }

        // Ensure that same file doesn't exists yet
        $ext = '';
        $i   = 1;
        while($this->fileExists($path.$name.$ext)) {
            $ext = '_'.$i;
            $i++;
        }

        return $path.$name.$ext;
    }

    function fileExists($path) {
        return is_file($path);
    }

}