1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Copyright (c) Xerox Corporation, Codendi Team, 2001-2009. All rights reserved |
4
|
|
|
* |
5
|
|
|
* This file is a part of Codendi. |
6
|
|
|
* |
7
|
|
|
* Codendi is free software; you can redistribute it and/or modify |
8
|
|
|
* it under the terms of the GNU General Public License as published by |
9
|
|
|
* the Free Software Foundation; either version 2 of the License, or |
10
|
|
|
* (at your option) any later version. |
11
|
|
|
* |
12
|
|
|
* Codendi is distributed in the hope that it will be useful, |
13
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
14
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15
|
|
|
* GNU General Public License for more details. |
16
|
|
|
* |
17
|
|
|
* You should have received a copy of the GNU General Public License |
18
|
|
|
* along with Codendi. If not, see <http://www.gnu.org/licenses/>. |
19
|
|
|
*/ |
20
|
|
|
|
21
|
|
|
/** |
22
|
|
|
* Service |
23
|
|
|
*/ |
24
|
|
|
class Service { |
25
|
|
|
|
26
|
|
|
const SUMMARY = 'summary'; |
27
|
|
|
const ADMIN = 'admin'; |
28
|
|
|
const FORUM = 'forum'; |
29
|
|
|
const HOMEPAGE = 'homepage'; |
30
|
|
|
const ML = 'mail'; |
31
|
|
|
const SURVEY = 'survey'; |
32
|
|
|
const NEWS = 'news'; |
33
|
|
|
const CVS = 'cvs'; |
34
|
|
|
const FILE = 'file'; |
35
|
|
|
const SVN = 'svn'; |
36
|
|
|
const WIKI = 'wiki'; |
37
|
|
|
const TRACKERV3 = 'tracker'; |
38
|
|
|
const LEGACYDOC = 'doc'; |
39
|
|
|
|
40
|
|
|
public $data; |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* @var Project |
44
|
|
|
*/ |
45
|
|
|
public $project; |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* Create an instance of Service |
49
|
|
|
* |
50
|
|
|
* @param Project $project The project the service belongs to |
51
|
|
|
* @param array $data The service data coming from the db |
52
|
|
|
* |
53
|
|
|
* @throws ServiceNotAllowedForProjectException if the Service is not allowed for the project (mainly for plugins) |
54
|
|
|
*/ |
55
|
|
|
public function __construct($project, $data) { |
56
|
|
|
if (!$this->isAllowed($project)) { |
57
|
|
|
throw new ServiceNotAllowedForProjectException(); |
58
|
|
|
} |
59
|
|
|
$this->project = $project; |
60
|
|
|
$this->data = $data; |
61
|
|
|
} |
62
|
|
|
|
63
|
|
|
public function getProject() { |
64
|
|
|
return $this->project; |
65
|
|
|
} |
66
|
|
|
function getGroupId() { |
67
|
|
|
return $this->data['group_id']; |
68
|
|
|
} |
69
|
|
|
function getId() { |
70
|
|
|
return $this->data['service_id']; |
71
|
|
|
} |
72
|
|
|
function getDescription() { |
73
|
|
|
return $this->data['description']; |
74
|
|
|
} |
75
|
|
|
function getShortName() { |
76
|
|
|
return $this->data['short_name']; |
77
|
|
|
} |
78
|
|
|
function getLabel() { |
79
|
|
|
return $this->data['label']; |
80
|
|
|
} |
81
|
|
|
function getRank() { |
82
|
|
|
return $this->data['rank']; |
83
|
|
|
} |
84
|
|
|
function isUsed() { |
85
|
|
|
return $this->data['is_used']; |
86
|
|
|
} |
87
|
|
|
function isActive() { |
88
|
|
|
return $this->data['is_active']; |
89
|
|
|
} |
90
|
|
|
function isIFrame() { |
91
|
|
|
return $this->data['is_in_iframe']; |
92
|
|
|
} |
93
|
|
|
function getUrl($url = null) { |
94
|
|
|
if (is_null($url)) { |
95
|
|
|
$url = $this->data['link']; |
96
|
|
|
} |
97
|
|
|
return $url; |
98
|
|
|
} |
99
|
|
|
|
100
|
|
|
public function getScope() { |
101
|
|
|
return $this->data['scope']; |
102
|
|
|
} |
103
|
|
|
|
104
|
|
|
/** |
105
|
|
|
* @see http://www.ietf.org/rfc/rfc2396.txt Annex B |
106
|
|
|
*/ |
107
|
|
|
function isAbsolute($url) { |
108
|
|
|
$components = array(); |
109
|
|
|
preg_match('`^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?`i', $url, $components); |
110
|
|
|
return isset($components[1]) && $components[1] ? true : false; |
111
|
|
|
} |
112
|
|
|
function _sessionIsSecure() { |
113
|
|
|
return session_issecure(); |
114
|
|
|
} |
115
|
|
|
function getPublicArea() { |
116
|
|
|
} |
117
|
|
|
function isRequestedPageDistributed(&$request) { |
118
|
|
|
return false; |
119
|
|
|
} |
120
|
|
|
|
121
|
|
|
public function displayHeader($title, $breadcrumbs, $toolbar, $params = array()) { |
122
|
|
|
$GLOBALS['HTML']->setRenderedThroughService(true); |
123
|
|
|
$GLOBALS['HTML']->addBreadcrumbs($breadcrumbs); |
124
|
|
|
|
125
|
|
|
foreach($toolbar as $t) { |
126
|
|
|
$class = isset($t['class']) ? 'class="'. $t['class'] .'"' : ''; |
127
|
|
|
$item_title = isset($t['short_title']) ? $t['short_title'] :$t['title']; |
128
|
|
|
$GLOBALS['HTML']->addToolbarItem('<a href="'. $t['url'] .'" '. $class .'>'. $item_title .'</a>'); |
129
|
|
|
} |
130
|
|
|
$params['title'] = $title; |
131
|
|
|
$params['group'] = $this->project->group_id; |
132
|
|
|
$params['toptab'] = $this->getId(); |
133
|
|
|
|
134
|
|
|
if (! isset($params['body_class'])) { |
135
|
|
|
$params['body_class'] = array(); |
136
|
|
|
} |
137
|
|
|
$params['body_class'][] = 'service-'. $this->getShortName(); |
138
|
|
|
|
139
|
|
|
if ($pv = (int)HTTPRequest::instance()->get('pv')) { |
140
|
|
|
$params['pv'] = (int)$pv; |
141
|
|
|
} |
142
|
|
|
|
143
|
|
|
$this->displayDuplicateInheritanceWarning(); |
144
|
|
|
|
145
|
|
|
site_project_header($params); |
146
|
|
|
} |
147
|
|
|
|
148
|
|
|
/** |
149
|
|
|
* Display a warning if the service configuration is not inherited on project creation |
150
|
|
|
*/ |
151
|
|
|
public function displayDuplicateInheritanceWarning() { |
152
|
|
|
if ($this->project->isTemplate() && !$this->isInheritedOnDuplicate()) { |
153
|
|
|
$GLOBALS['HTML']->addFeedback('warning', $GLOBALS['Language']->getText('global', 'service_conf_not_inherited')); |
154
|
|
|
} |
155
|
|
|
} |
156
|
|
|
|
157
|
|
|
public function displayFooter() { |
158
|
|
|
$params = array( |
159
|
|
|
'group' => $this->project->group_id, |
160
|
|
|
); |
161
|
|
|
if ($pv = (int)HTTPRequest::instance()->get('pv')) { |
162
|
|
|
$params['pv'] = (int)$pv; |
163
|
|
|
} |
164
|
|
|
site_project_footer($params); |
165
|
|
|
} |
166
|
|
|
|
167
|
|
|
public function duplicate($to_project_id, $ugroup_mapping) { |
168
|
|
|
} |
169
|
|
|
|
170
|
|
|
/** |
171
|
|
|
* Say if the service is allowed for the project |
172
|
|
|
* |
173
|
|
|
* @param Project $project |
174
|
|
|
* |
175
|
|
|
* @return bool |
176
|
|
|
*/ |
177
|
|
|
protected function isAllowed($project) { |
178
|
|
|
return true; |
179
|
|
|
} |
180
|
|
|
|
181
|
|
|
/** |
182
|
|
|
* Say if the service is restricted |
183
|
|
|
* |
184
|
|
|
* @param Project $project |
|
|
|
|
185
|
|
|
* |
186
|
|
|
* @return bool |
187
|
|
|
*/ |
188
|
|
|
public function isRestricted() { |
189
|
|
|
return false; |
190
|
|
|
} |
191
|
|
|
|
192
|
|
|
/** |
193
|
|
|
* Return true if service configuration is inherited on clone |
194
|
|
|
* |
195
|
|
|
* @return Boolean |
196
|
|
|
*/ |
197
|
|
|
public function isInheritedOnDuplicate() { |
198
|
|
|
return false; |
199
|
|
|
} |
200
|
|
|
|
201
|
|
|
public function getInternationalizedName() { |
202
|
|
|
return $GLOBALS['Language']->getText('project_admin_editservice', $this->getLabel()); |
203
|
|
|
} |
204
|
|
|
} |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italy
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was removed, but the annotation was not.