summaryrefslogtreecommitdiffstats
path: root/lib/kolab_json_output.php
blob: 473e5797377a9003d72a4a8e84aa9cbbe118b743 (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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?php
/*
 +--------------------------------------------------------------------------+
 | This file is part of the Kolab Web Admin Panel                           |
 |                                                                          |
 | Copyright (C) 2011-2012, Kolab Systems AG                                |
 |                                                                          |
 | This program is free software: you can redistribute it and/or modify     |
 | it under the terms of the GNU Affero General Public License as published |
 | by the Free Software Foundation, either version 3 of the License, or     |
 | (at your option) any later version.                                      |
 |                                                                          |
 | This program 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 Affero General Public License for more details.                      |
 |                                                                          |
 | You should have received a copy of the GNU Affero General Public License |
 | along with this program. If not, see <http://www.gnu.org/licenses/>      |
 +--------------------------------------------------------------------------+
 | Author: Jeroen van Meeuwen <vanmeeuwen@kolabsys.com>                     |
 | Author: Aleksander Machniak <machniak@kolabsys.com>                      |
 +--------------------------------------------------------------------------+
*/

/**
 * View class generating JSON output
 */
class kolab_json_output
{

    /**
     * Send success response
     *
     * @param mixed $data Data
     */
    public function success($data)
    {
        if (!is_array($data)) {
            $data = array();
        }

        $this->send(array('status' => 'OK', 'result' => $data));
    }


    /**
     * Send error response
     *
     * @param mixed $data Data
     */
    public function error($errdata, $code = 400)
    {
        if (is_string($errdata)) {
            $errdata = array('reason' => $errdata);
        }

        $this->send(array('status' => 'ERROR', 'code' => $code) + $errdata);
    }


    /**
     * Send response
     *
     * @param mixed $data Data
     */
    protected function send($data)
    {
        // Encode response
        self::encode($data);

        // Send response
        header("Content-Type: application/json");
        echo json_encode($data);
        exit;
    }


    /**
     * Parse response and base64-encode non-UTF8/binary data
     *
     * @param mixed $data Data
     *
     * @return bool True if data was encoded
     */
    public static function encode(&$data)
    {
        if (is_array($data)) {
            $encoded = array();
            foreach (array_keys($data) as $key) {
                if (self::encode($data[$key])) {
                    $encoded[] = $key;
                }
            }
            if (!empty($encoded)) {
                $data['__encoded'] = $encoded;
            }
        }
        else if (is_string($data) && $data !== '') {
            $result = @json_encode($data);
            // In case of invalid characters json_encode returns "null"
            if (($result === 'null' && $data != 'null') || $result === false) {
                $data = base64_encode($data);
                return true;
            }
        }

        return false;
    }


    /**
     * Parse response and base64-decode encoded data
     *
     * @param mixed $data Data
     */
    public static function decode(&$data)
    {
        if (is_array($data)) {
            $encoded = $data['__encoded'];
            foreach ($data as $key => $value) {
                if (is_array($value)) {
                    self::decode($data[$key]);
                }
                else if (is_string($value) && $encoded && in_array($key, $encoded)) {
                    $data[$key] = base64_decode($value);
                }
            }
            unset($data['__encoded']);
        }
    }

}