Consolidate copy-and-pasted diff mode cookie code
[gitphp.git] / include / controller / Controller_Commitdiff.class.php
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?php
/**
 * GitPHP Controller Commitdiff
 *
 * Controller for displaying a commitdiff
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Controller
 */
 
/**
 * Constants for blobdiff modes
 */
define('GITPHP_BLOBDIFF_UNIFIED', 1);
define('GITPHP_BLOBDIFF_SIDEBYSIDE', 2);
 
/**
 * Constant of the blobdiff mode cookie in the user's browser
 */
define('GITPHP_BLOBDIFF_MODE_COOKIE', 'GitPHPBlobdiffMode');
 
/**
 * Blobdiff mode cookie lifetime
 */
define('GITPHP_BLOBDIFF_MODE_COOKIE_LIFETIME', 60*60*24*365);           // 1 year
 
/**
 * Commitdiff controller class
 *
 * @package GitPHP
 * @subpackage Controller
 */
class GitPHP_Controller_Commitdiff extends GitPHP_ControllerBase
{
 
        /**
         * __construct
         *
         * Constructor
         *
         * @access public
         * @return controller
         */
        public function __construct()
        {
                parent::__construct();
                if (!$this->project) {
                        throw new GitPHP_MessageException(__('Project is required'), true);
                }
        }
 
        /**
         * GetTemplate
         *
         * Gets the template for this controller
         *
         * @access protected
         * @return string template filename
         */
        protected function GetTemplate()
        {
                if (isset($this->params['plain']) && ($this->params['plain'] === true)) {
                        return 'commitdiffplain.tpl';
                }
                return 'commitdiff.tpl';
        }
 
        /**
         * GetCacheKey
         *
         * Gets the cache key for this controller
         *
         * @access protected
         * @return string cache key
         */
        protected function GetCacheKey()
        {
                $key = (isset($this->params['hash']) ? $this->params['hash'] : '')
                . '|' . (isset($this->params['hashparent']) ? $this->params['hashparent'] : '')
                . '|' . (isset($this->params['sidebyside']) && ($this->params['sidebyside'] === true) ? '1' : '');
 
                return $key;
        }
 
        /**
         * GetName
         *
         * Gets the name of this controller's action
         *
         * @access public
         * @param boolean $local true if caller wants the localized action name
         * @return string action name
         */
        public function GetName($local = false)
        {
                if ($local) {
                        return __('commitdiff');
                }
                return 'commitdiff';
        }
 
        /**
         * ReadQuery
         *
         * Read query into parameters
         *
         * @access protected
         */
        protected function ReadQuery()
        {
                if (isset($_GET['h']))
                        $this->params['hash'] = $_GET['h'];
                if (isset($_GET['hp']))
                        $this->params['hashparent'] = $_GET['hp'];
 
                if (!isset($this->params['plain']) || $this->params['plain'] != true) {
 
                        $mode = GITPHP_BLOBDIFF_UNIFIED;        // default
 
 
                        /*
                         * Check cookie
                         */
                        if (!empty($_COOKIE[GITPHP_BLOBDIFF_MODE_COOKIE])) {
                                $mode = $_COOKIE[GITPHP_BLOBDIFF_MODE_COOKIE];
                        } else {
                                /*
                                 * Create cookie to prevent browser delay
                                 */
                                setcookie(GITPHP_BLOBDIFF_MODE_COOKIE, $mode, time()+GITPHP_BLOBDIFF_MODE_COOKIE_LIFETIME);
                        }
 
                        if (isset($_GET['o'])) {
                                /*
                                 * User is choosing a new mode
                                 */
                                if ($_GET['o'] == 'sidebyside') {
                                        $mode = GITPHP_BLOBDIFF_SIDEBYSIDE;
                                        setcookie(GITPHP_BLOBDIFF_MODE_COOKIE, GITPHP_BLOBDIFF_SIDEBYSIDE, time()+GITPHP_BLOBDIFF_MODE_COOKIE_LIFETIME);
                                } else if ($_GET['o'] == 'unified') {
                                        $mode = GITPHP_BLOBDIFF_UNIFIED;
                                        setcookie(GITPHP_BLOBDIFF_MODE_COOKIE, GITPHP_BLOBDIFF_UNIFIED, time()+GITPHP_BLOBDIFF_MODE_COOKIE_LIFETIME);
                                }
                        }
 
                        if ($mode == GITPHP_BLOBDIFF_SIDEBYSIDE) {
                                $this->params['sidebyside'] = true;
                        }
                }
        }
 
        /**
         * LoadHeaders
         *
         * Loads headers for this template
         *
         * @access protected
         */
        protected function LoadHeaders()
        {
                if (isset($this->params['plain']) && ($this->params['plain'] === true)) {
                        GitPHP_Log::GetInstance()->SetEnabled(false);
 
                        $this->headers[] = 'Content-type: text/plain; charset=UTF-8';
                        $this->headers[] = 'Content-disposition: inline; filename="git-' . $this->params['hash'] . '.patch"';
                }
        }
 
        /**
         * LoadData
         *
         * Loads data for this template
         *
         * @access protected
         */
        protected function LoadData()
        {
                $co = $this->project->GetCommit($this->params['hash']);
                $this->tpl->assign('commit', $co);
 
                if (isset($this->params['hashparent'])) {
                        $this->tpl->assign("hashparent", $this->params['hashparent']);
                }
 
                if (isset($this->params['sidebyside']) && ($this->params['sidebyside'] === true)) {
                        $this->tpl->assign('sidebyside', true);
                }
 
                $treediff = new GitPHP_TreeDiff($this->project, $this->params['hash'], (isset($this->params['hashparent']) ? $this->params['hashparent'] : ''));
                $this->tpl->assign('treediff', $treediff);
        }
 
}
 
comments