| Notifications |
);
- if($site->getNotify()) {
+ if ($site->getNotify()) {
echo('img/tick.png');
} else {
echo('img/cross.png');
@@ -135,7 +149,9 @@
<!-- Project Data -->
<div class=)
-
+
 ?>img/project.png)
@@ -146,7 +162,10 @@
- | Infrastructure | getInfrastructure()->getName()) ?> |
+ Infrastructure |
+
+ getInfrastructure()->getName()) ?>
+ |
| Certification Status |
@@ -155,29 +174,31 @@
getCertificationStatus()->getName()) ?>
-
+
Change
-
+
$sharedWithParent) {
- if ($sharedWithParent) {
- $scopeString .= $scopeName;
- } else {
- $scopeString .= $scopeName . '(x)';
- }
- if (++$count != $numScopes) {
- $scopeString .= ", ";
- }
- }
- ?>
+ $count = 0;
+ $numScopes = sizeof($params['Scopes']);
+ $scopeString = '';
+ foreach ($params['Scopes'] as $scopeName => $sharedWithParent) {
+ if ($sharedWithParent) {
+ $scopeString .= $scopeName;
+ } else {
+ $scopeString .= $scopeName . '(x)';
+ }
+ if (++$count != $numScopes) {
+ $scopeString .= ", ";
+ }
+ }
+ ?>
@@ -197,7 +218,9 @@
-
+
 ?>img/network.png)
@@ -207,7 +230,9 @@
getHomeUrl()) ?>
-
+
@@ -216,8 +241,9 @@
getGiisUrl());
- } else
+ } else {
echo(getInfoMessage());
+ }
?>
@@ -227,8 +253,9 @@
getIpRange());
- } else
+ } else {
echo(getInfoMessage());
+ }
?>
@@ -238,8 +265,9 @@
getIpV6Range());
- } else
+ } else {
echo(getInfoMessage());
+ }
?>
@@ -247,10 +275,11 @@
Domain |
getDomain());
- } else
- echo(getInfoMessage());
+ if ($showPD) {
+ xecho($site->getDomain());
+ } else {
+ echo(getInfoMessage());
+ }
?>
|
@@ -259,7 +288,9 @@
-
+
 ?>img/pin.png)
@@ -353,9 +384,9 @@
+ $se = $serviceAndScopes['Service'];
+ $scopes = $serviceAndScopes['Scopes'];
+ ?>
|
@@ -363,37 +394,35 @@
|
-
+
|
getProduction()) {
- case true:
- ?>
-  ?>img/tick.png)
-
-  ?>img/cross.png)
- ';
+ break;
+ case false:
+ echo ' .
+ 'img/cross.png) ';
+ break;
}
?>
|
getMonitored()) {
- case true:
- ?>
-
-
-
- ';
+ break;
+ case false:
+ echo '';
+ break;
}
?>
|
@@ -403,22 +432,22 @@
$numScopes = sizeof($scopes);
$scopeString = '';
foreach ($scopes as $scopeName => $sharedWithParent) {
- if ($sharedWithParent) {
- $scopeString .= $scopeName;
- } else {
- $scopeString .= $scopeName . '(x)';
- }
- if (++$count != $numScopes) {
- $scopeString .= ", ";
- }
+ if ($sharedWithParent) {
+ $scopeString .= $scopeName;
+ } else {
+ $scopeString .= $scopeName . '(x)';
+ }
+ if (++$count != $numScopes) {
+ $scopeString .= ", ";
+ }
}
?>
+ } // End of the foreach loop iterating over ServicesAndScopes
+ ?>
@@ -427,21 +456,30 @@
-  ?>img/add.png)
-
-
+ if ($showPD) {
+ ?>
+
 ?>img/people.png)
@@ -453,12 +491,16 @@
+ ?>
|
@@ -469,20 +511,20 @@
?>
|
-
-
|
-
+
getDescription()) ?>
|
getStartDate()->format('Y-m-d H:i'/*$dt::DATE_FORMAT*/)) ?> |
getEndDate()->format('Y-m-d H:i'/*$dt::DATE_FORMAT*/)) ?> |
-
-
+
-
-
@@ -543,10 +594,11 @@
?>
-
+
 ?>img/key.png)
@@ -555,8 +607,9 @@
| Type |
Identifier |
User |
- API Write |
- Edit |
+ Last Used |
+ Write |
+ Edit |
Delete |
@@ -573,7 +626,7 @@
// delete the credential
$disableDelete = false;
}
- ?>
+ ?>
|
getType())?>
@@ -587,34 +640,56 @@
$disableDelete = false;
if ($APIAuthEnt->getUser() != null) {
// Credentials added prior to 5.8 have no owning user
- echo "getUser()->getId(), "\" ";
+ echo "getUser()->getId(),
+ "\" ";
echo "title=\"", $APIAuthEnt->getUser()->getFullname(), "\">";
- echo substr($APIAuthEnt->getUser()->getSurname(),0,10);
+ echo substr($APIAuthEnt->getUser()->getSurname(), 0, 10);
echo "";
}
?>
|
+
+ getLastUseTime();
+ if ($useTime == null) {
+ $titleStr = 'Created/Renewed ' . $APIAuthEnt->getLastRenewTime()->format('d-m-Y H:iTP');
+ echo ' Unused ';
+ } else {
+ $titleStr = 'Last used ' . $useTime->format('d-m-Y H:iTP');
+ echo '' . $useTime->format('d-m-y') . ' ';
+ }
+ ?>
+ |
 getAllowAPIWrite())) {
- echo '"'.\GocContextPath::getPath().'img/tick.png"';
+ echo '"' . \GocContextPath::getPath() . 'img/tick.png"';
+ echo 'title="API write enabled"';
} else {
- echo '"'.\GocContextPath::getPath().'img/cross.png"';
+ echo '"' . \GocContextPath::getPath() . 'img/cross.png"';
+ echo 'title="API write disabled"';
} ?>
/>
|
-
- |
-
- |
-
+
-
-
diff --git a/htdocs/web_portal/views/user/deleted_user.php b/htdocs/web_portal/views/user/deleted_user.php
index e55bcc510..cfcfbdb30 100644
--- a/htdocs/web_portal/views/user/deleted_user.php
+++ b/htdocs/web_portal/views/user/deleted_user.php
@@ -3,4 +3,4 @@
User deleted.
Go Home
-
\ No newline at end of file
+
diff --git a/htdocs/web_portal/views/user/deleted_user_identifier.php b/htdocs/web_portal/views/user/deleted_user_identifier.php
index 34f79f761..a6a5141f3 100644
--- a/htdocs/web_portal/views/user/deleted_user_identifier.php
+++ b/htdocs/web_portal/views/user/deleted_user_identifier.php
@@ -4,4 +4,4 @@
View user
-
\ No newline at end of file
+
diff --git a/htdocs/web_portal/views/user/link_identity.php b/htdocs/web_portal/views/user/link_identity.php
index 1ffb3c5e8..ff5513281 100644
--- a/htdocs/web_portal/views/user/link_identity.php
+++ b/htdocs/web_portal/views/user/link_identity.php
@@ -1,59 +1,24 @@
- Link Identity or Recover an Account
-
-
-
+ Link Identifier or Recover an Account
- What is identity linking?
-
- -
- You can use this process to add your current authentication method as a way to log in to an existing account.
-
- -
- This allows access to a single account through two or more identifiers.
-
- -
- You must have access to the email address associated with the account being linked.
-
- -
- Your current authentication type must be different to any authentication types already associated
- with the account being linked.
-
-
-
- What is account recovery?
-
- -
- If your identifier has changed, you can use this process to update it and regain control of your old account.
-
- -
- You must have access to the email address associated with your old account.
-
- -
- Your current authentication type must be the same as the authentication type you enter for your old account.
-
+ This page allows you to either add a new identifier to an exisiting GOCDB
+ account, or recover a GOCDB account if your identifier has changed. You
+ must have access to the email address associated with that GOCDB account.
+ You must be authenticated with the new identifier.
-
-
\ No newline at end of file
+ Success
Your identifier has been successfully
-
\ No newline at end of file
+
diff --git a/htdocs/web_portal/views/user/registered.php b/htdocs/web_portal/views/user/registered.php
index a23ab75e4..8cd1cfd9b 100644
--- a/htdocs/web_portal/views/user/registered.php
+++ b/htdocs/web_portal/views/user/registered.php
@@ -6,4 +6,4 @@
New user registered.
View user
-
\ No newline at end of file
+
diff --git a/htdocs/web_portal/views/user/user_updated.php b/htdocs/web_portal/views/user/user_updated.php
index 5da2449be..56dc7e87e 100644
--- a/htdocs/web_portal/views/user/user_updated.php
+++ b/htdocs/web_portal/views/user/user_updated.php
@@ -3,4 +3,4 @@
User updated.
View user
-
\ No newline at end of file
+
diff --git a/htdocs/web_portal/views/user/view_user.php b/htdocs/web_portal/views/user/view_user.php
index cd5a6d64e..866ab9637 100644
--- a/htdocs/web_portal/views/user/view_user.php
+++ b/htdocs/web_portal/views/user/view_user.php
@@ -20,8 +20,7 @@
if ($params['ShowEdit']) {?>
';
@@ -74,7 +72,9 @@
-
+ isAdmin();
+ ?>
|
+
+
+ | Last Logged In |
+
+ getLastLoginDate()) {
+ xecho(
+ $params['user']->getLastLoginDate()
+ ->format('Y-m-d H:i:s')
+ );
+ }
+ ?>
+ |
+
+
diff --git a/lib/Authentication/_autoload.php b/lib/Authentication/_autoload.php
index bed78a5a8..1e1ca4e7a 100644
--- a/lib/Authentication/_autoload.php
+++ b/lib/Authentication/_autoload.php
@@ -73,4 +73,3 @@ function securityLoader($className){
spl_autoload_register(__NAMESPACE__ .'\securityLoader', false);
-
diff --git a/lib/DAOs/AbstractDAO.php b/lib/DAOs/AbstractDAO.php
index b80927402..894585518 100644
--- a/lib/DAOs/AbstractDAO.php
+++ b/lib/DAOs/AbstractDAO.php
@@ -25,4 +25,4 @@ public function setEntityManager(\Doctrine\ORM\EntityManager $em){
public function getEntityManager(){
return $this->em;
}
-}
\ No newline at end of file
+}
diff --git a/lib/DAOs/NGIDAO.php b/lib/DAOs/NGIDAO.php
index 168784e26..ee87cb3e6 100644
--- a/lib/DAOs/NGIDAO.php
+++ b/lib/DAOs/NGIDAO.php
@@ -51,4 +51,4 @@ public function addNGIToArchive(\NGI $ngi, \User $user){
$this->em->persist($archievedNgi);
}
-}
\ No newline at end of file
+}
diff --git a/lib/Doctrine/entities/APIAuthentication.php b/lib/Doctrine/entities/APIAuthentication.php
index e4288f67c..61a4129bc 100644
--- a/lib/Doctrine/entities/APIAuthentication.php
+++ b/lib/Doctrine/entities/APIAuthentication.php
@@ -1,4 +1,5 @@
setLastRenewTime();
}
/**
* Get PK of Authentication entity
* @return int
*/
- public function getId() {
+ public function getId()
+ {
return $this->id;
}
@@ -93,7 +106,8 @@ public function getId() {
* Get the authentication enties parent site
* @return \Site
*/
- public function getParentSite() {
+ public function getParentSite()
+ {
return $this->parentSite;
}
@@ -101,7 +115,8 @@ public function getParentSite() {
* Get they autentication type of this entity
* @return string
*/
- public function getType() {
+ public function getType()
+ {
return $this->type;
}
@@ -109,35 +124,40 @@ public function getType() {
* Get the unique identifier for this autnentication entity.
* @return string
*/
- public function getIdentifier() {
+ public function getIdentifier()
+ {
return $this->identifier;
}
/**
* @return \User
*/
- public function getUser() {
+ public function getUser()
+ {
return $this->user;
}
/**
* @return bool $allowAPIWrite
*/
- public function getAllowAPIWrite () {
+ public function getAllowAPIWrite()
+ {
return $this->allowAPIWrite;
}
/**
* @return \DateTime
*/
- public function getLastUseTime () {
+ public function getLastUseTime()
+ {
return $this->lastUseTime;
}
/**
* @return \DateTime $time
*/
- protected function getLastRenewTime() {
+ public function getLastRenewTime()
+ {
return $this->lastRenewTime;
}
@@ -145,7 +165,8 @@ protected function getLastRenewTime() {
* Set the type of this authentication entity
* @param string $name
*/
- public function setType($type) {
+ public function setType($type)
+ {
$this->type = $type;
}
@@ -153,14 +174,16 @@ public function setType($type) {
* Set the unique identifier of this authentication entity.
* @param string $identifier
*/
- public function setIdentifier($identifier) {
+ public function setIdentifier($identifier)
+ {
$this->identifier = $identifier;
}
/**
* @param \DateTime $time if null, current UTC time is set
*/
- public function setLastUseTime (\DateTime $time = null) {
+ public function setLastUseTime(\DateTime $time = null)
+ {
$useTime = $time;
@@ -174,7 +197,8 @@ public function setLastUseTime (\DateTime $time = null) {
/**
* @param \DateTime $time if null, current UTC time is set
*/
- public function setLastRenewTime(\DateTime $time = null) {
+ public function setLastRenewTime(\DateTime $time = null)
+ {
$renewTime = $time;
@@ -189,9 +213,10 @@ public function setLastRenewTime(\DateTime $time = null) {
*
* @param bool $allowAPIWrite
*/
- public function setAllowAPIWrite ($allowWrite) {
+ public function setAllowAPIWrite($allowWrite)
+ {
if (!is_bool($allowWrite)) {
- throw new LogicException("Expected bool, received".gettype($allowWrite));
+ throw new LogicException("Expected bool, received" . gettype($allowWrite));
}
$this->allowAPIWrite = $allowWrite;
}
@@ -207,13 +232,15 @@ public function setAllowAPIWrite ($allowWrite) {
*
* @param \Site $site
*/
- public function _setParentSite(\Site $site){
+ public function _setParentSite(\Site $site)
+ {
$this->parentSite = $site;
}
/**
* @param \User $user
*/
- public function _setUser(\User $user) {
+ public function _setUser(\User $user)
+ {
$this->user = $user;
}
- }
+}
diff --git a/lib/Doctrine/entities/ServiceType.php b/lib/Doctrine/entities/ServiceType.php
index 2e3d231c1..a3ac63567 100644
--- a/lib/Doctrine/entities/ServiceType.php
+++ b/lib/Doctrine/entities/ServiceType.php
@@ -24,8 +24,8 @@
*
* @Entity @Table(name="ServiceTypes", options={"collate"="utf8mb4_bin", "charset"="utf8mb4"})
*/
-class ServiceType {
-
+class ServiceType
+{
/** @Id @Column(type="integer") @GeneratedValue */
protected $id;
@@ -38,14 +38,24 @@ class ServiceType {
/** @OneToMany(targetEntity="Service", mappedBy="serviceType") */
protected $services = null;
- public function __construct() {
+ /**
+ * An instance of a Service of this ServiceType may
+ * unmonitored while in production.
+ * @Column(type="boolean", options={"default":FALSE})
+ */
+ protected $monitoringException;
+
+ public function __construct()
+ {
$this->services = new ArrayCollection();
+ $this->monitoringException = false;
}
/**
* @return int The PK of this entity or null if not persisted
*/
- public function getId() {
+ public function getId()
+ {
return $this->id;
}
@@ -53,7 +63,8 @@ public function getId() {
* Get the unique name of this service type.
* @return string
*/
- public function getName() {
+ public function getName()
+ {
return $this->name;
}
@@ -61,7 +72,8 @@ public function getName() {
* Get the human readable description of this service type.
* @return string or null
*/
- public function getDescription() {
+ public function getDescription()
+ {
return $this->description;
}
@@ -69,7 +81,8 @@ public function getDescription() {
* Set the unique name of this service type. Required.
* @param string $name
*/
- public function setName($name) {
+ public function setName($name)
+ {
$this->name = $name;
}
@@ -77,7 +90,8 @@ public function setName($name) {
* Set the human readable description of this service type.
* @param string $description
*/
- public function setDescription($description) {
+ public function setDescription($description)
+ {
$this->description = $description;
}
@@ -85,7 +99,8 @@ public function setDescription($description) {
* Get all the {@see Service}s that are linked to this service type.
* @return ArrayCollection
*/
- public function getServices() {
+ public function getServices()
+ {
return $this->services;
}
@@ -95,17 +110,37 @@ public function getServices() {
* to establish the join on both sides of the relationship.
* @param \Service $service
*/
- public function addService($service) {
+ public function addService($service)
+ {
$this->services[] = $service;
$service->setServiceType($this);
}
+ /**
+ * Add an exception where an instance of this ServiceType is allowed
+ * to be unmonitored when in production with a specific Scope.
+ * Return value is the existing boolean state
+ */
+ public function setAllowMonitoringException($state)
+ {
+ $oldState = $this->getAllowMonitoringException();
+ $this->monitoringException = $state;
+ return $oldState;
+ }
+ /**
+ * Check if a monitoring exception is allowed within the given scope.
+ */
+ public function getAllowMonitoringException()
+ {
+ return $this->monitoringException;
+ }
+
/**
* Gets the name of this service type.
* @return string
*/
- public function __toString() {
+ public function __toString()
+ {
return $this->getName();
}
-
}
diff --git a/lib/Gocdb_Services/CertificationStatus.php b/lib/Gocdb_Services/CertificationStatus.php
index 25252a6a9..0ad274572 100644
--- a/lib/Gocdb_Services/CertificationStatus.php
+++ b/lib/Gocdb_Services/CertificationStatus.php
@@ -160,4 +160,4 @@ public function isChangeValid(\Site $site, \CertificationStatus $newCertStatus)
}
}
}
-?>
\ No newline at end of file
+?>
diff --git a/lib/Gocdb_Services/Config.php b/lib/Gocdb_Services/Config.php
index b7bd22328..59576f417 100644
--- a/lib/Gocdb_Services/Config.php
+++ b/lib/Gocdb_Services/Config.php
@@ -157,7 +157,6 @@ private function readLocalInfoXML($path, $url = null)
if (!$base) {
$this->throwXmlErrors('Failed to load configuration file ' . $path);
}
-
// Search the input XML for a 'local_info' section that does NOT have a url attribute
// specified. This is the default spec.
$unqualified = $base->xpath("//local_info[not(@url)]");
@@ -401,8 +400,9 @@ public function GetPortalURL()
*/
public function isRestrictPDByRole($forceStrict = false)
{
- if ($forceStrict === true)
+ if ($forceStrict === true) {
return true;
+ }
$localInfo = $this->GetLocalInfoXML();
$value = $localInfo->restrict_personal_data;
@@ -432,7 +432,18 @@ public function getServerBaseUrl()
$url = $localInfo->server_base_url;
return strval($url);
}
+ /**
+ * Convenience function to return the 3 configuration URLs
+ */
+ public function getURLs()
+ {
+ $localInfo = $this->GetLocalInfoXML();
+ $serverBaseUrl = $localInfo->server_base_url;
+ $webPortalUrl = $localInfo->web_portal_url;
+ $piUrl = $localInfo->pi_url;
+ return array($serverBaseUrl, $webPortalUrl, $piUrl);
+ }
/**
* The write API documentation URL as recorded in local_info.xml.
* This URL is given to users of the write API in error messages
@@ -552,7 +563,7 @@ public function getEmailFrom()
public function getEmailTo()
{
- $emailTo = $this->GetlocalInfoXML()->email_to;
+ $emailTo = $this->GetLocalInfoXML()->email_to;
return $emailTo;
}
diff --git a/lib/Gocdb_Services/ExtensionsService.php b/lib/Gocdb_Services/ExtensionsService.php
index 7930a8d0d..c1f05643a 100644
--- a/lib/Gocdb_Services/ExtensionsService.php
+++ b/lib/Gocdb_Services/ExtensionsService.php
@@ -58,4 +58,4 @@ public function getServiceGroupExtensionsKeyNames() {
return $qb->getQuery()->execute();
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetCertStatusChanges.php b/lib/Gocdb_Services/PI/GetCertStatusChanges.php
index 70a25c889..4835c0644 100644
--- a/lib/Gocdb_Services/PI/GetCertStatusChanges.php
+++ b/lib/Gocdb_Services/PI/GetCertStatusChanges.php
@@ -354,4 +354,4 @@ public function getPostExecutionPageInfo(){
$pageInfo['count'] = $this->resultSetSize;
return $pageInfo;
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetCertStatusDate.php b/lib/Gocdb_Services/PI/GetCertStatusDate.php
index ae3ad157b..e91f7c6cb 100644
--- a/lib/Gocdb_Services/PI/GetCertStatusDate.php
+++ b/lib/Gocdb_Services/PI/GetCertStatusDate.php
@@ -345,4 +345,4 @@ public function getPostExecutionPageInfo(){
$pageInfo['count'] = $this->resultSetSize;
return $pageInfo;
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetNGIContacts.php b/lib/Gocdb_Services/PI/GetNGIContacts.php
index 254ac19d1..514eec313 100644
--- a/lib/Gocdb_Services/PI/GetNGIContacts.php
+++ b/lib/Gocdb_Services/PI/GetNGIContacts.php
@@ -362,4 +362,4 @@ public function getPostExecutionPageInfo(){
$pageInfo['count'] = $this->resultSetSize;
return $pageInfo;
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetNGIList.php b/lib/Gocdb_Services/PI/GetNGIList.php
index 48cc2a768..92271e6e0 100644
--- a/lib/Gocdb_Services/PI/GetNGIList.php
+++ b/lib/Gocdb_Services/PI/GetNGIList.php
@@ -233,4 +233,4 @@ private function getXML(){
}*/
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetProjectContacts.php b/lib/Gocdb_Services/PI/GetProjectContacts.php
index 56c5b017c..181eaf2b5 100644
--- a/lib/Gocdb_Services/PI/GetProjectContacts.php
+++ b/lib/Gocdb_Services/PI/GetProjectContacts.php
@@ -342,4 +342,4 @@ public function getPostExecutionPageInfo(){
$pageInfo['count'] = $this->resultSetSize;
return $pageInfo;
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetServiceGroupRole.php b/lib/Gocdb_Services/PI/GetServiceGroupRole.php
index f8b05f1be..03d4a5bff 100644
--- a/lib/Gocdb_Services/PI/GetServiceGroupRole.php
+++ b/lib/Gocdb_Services/PI/GetServiceGroupRole.php
@@ -377,4 +377,4 @@ public function getPostExecutionPageInfo(){
$pageInfo['count'] = $this->resultSetSize;
return $pageInfo;
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetServiceTypes.php b/lib/Gocdb_Services/PI/GetServiceTypes.php
index 5ff72e1ad..3588ea738 100644
--- a/lib/Gocdb_Services/PI/GetServiceTypes.php
+++ b/lib/Gocdb_Services/PI/GetServiceTypes.php
@@ -180,4 +180,4 @@ private function getXML(){
return $xmlString;
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetSiteContacts.php b/lib/Gocdb_Services/PI/GetSiteContacts.php
index f91e290d1..c6af53fc5 100644
--- a/lib/Gocdb_Services/PI/GetSiteContacts.php
+++ b/lib/Gocdb_Services/PI/GetSiteContacts.php
@@ -390,4 +390,4 @@ public function getPostExecutionPageInfo(){
$pageInfo['count'] = $this->resultSetSize;
return $pageInfo;
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetSiteSecurityInfo.php b/lib/Gocdb_Services/PI/GetSiteSecurityInfo.php
index ac835bca2..73bc69d6b 100644
--- a/lib/Gocdb_Services/PI/GetSiteSecurityInfo.php
+++ b/lib/Gocdb_Services/PI/GetSiteSecurityInfo.php
@@ -353,4 +353,4 @@ public function getPostExecutionPageInfo(){
$pageInfo['count'] = $this->resultSetSize;
return $pageInfo;
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/GetSubGridList.php b/lib/Gocdb_Services/PI/GetSubGridList.php
index 083cedf55..ef2bac31d 100644
--- a/lib/Gocdb_Services/PI/GetSubGridList.php
+++ b/lib/Gocdb_Services/PI/GetSubGridList.php
@@ -175,4 +175,4 @@ private function getXML(){
$xmlString = $dom->saveXML ();
return $xmlString;
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/IPIQueryPageable.php b/lib/Gocdb_Services/PI/IPIQueryPageable.php
index 7d2d0471f..89d56d6b3 100644
--- a/lib/Gocdb_Services/PI/IPIQueryPageable.php
+++ b/lib/Gocdb_Services/PI/IPIQueryPageable.php
@@ -56,4 +56,4 @@ public function setPageSize($pageSize);
*/
public function getPostExecutionPageInfo();
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/PI/QueryBuilders/ExtensionsParser.php b/lib/Gocdb_Services/PI/QueryBuilders/ExtensionsParser.php
index 7b4e10c2b..1637694b7 100644
--- a/lib/Gocdb_Services/PI/QueryBuilders/ExtensionsParser.php
+++ b/lib/Gocdb_Services/PI/QueryBuilders/ExtensionsParser.php
@@ -161,4 +161,4 @@ private function checkLimit($parsedQueries){
}
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/Project.php b/lib/Gocdb_Services/Project.php
index 4dea41209..61e55ea29 100644
--- a/lib/Gocdb_Services/Project.php
+++ b/lib/Gocdb_Services/Project.php
@@ -468,5 +468,3 @@ private function validate($projectData) {
}
}
}
-
-
diff --git a/lib/Gocdb_Services/Scope.php b/lib/Gocdb_Services/Scope.php
index 84eafd766..40ddca0ed 100644
--- a/lib/Gocdb_Services/Scope.php
+++ b/lib/Gocdb_Services/Scope.php
@@ -545,4 +545,4 @@ private function validate($scopeData, $scopeIsNew, $oldScopeName = '') {
}
}
-}
\ No newline at end of file
+}
diff --git a/lib/Gocdb_Services/Search.php b/lib/Gocdb_Services/Search.php
index 5103a99b3..6b5b42106 100644
--- a/lib/Gocdb_Services/Search.php
+++ b/lib/Gocdb_Services/Search.php
@@ -101,4 +101,21 @@ public function getNgis($searchTerm) {
return $ngis;
}
-}
\ No newline at end of file
+ /**
+ * When the user is admin, it retrieves the matching identifiers.
+ */
+ public function getSiteIdentifiers($user, $searchTerm)
+ {
+ if ($user->isAdmin()) {
+ $dql = "SELECT ui FROM APIAuthentication ui "
+ . " WHERE UPPER(ui.identifier) "
+ . " LIKE UPPER(concat(concat('%', :searchTerm), '%'))";
+ $siteIdentifiers = $this->em
+ ->createQuery($dql)
+ ->setParameter(":searchTerm", $searchTerm)
+ ->getResult();
+
+ return $siteIdentifiers;
+ }
+ }
+}
diff --git a/lib/Gocdb_Services/SecurityContextSource.php b/lib/Gocdb_Services/SecurityContextSource.php
index c2dc0a284..618fa8404 100644
--- a/lib/Gocdb_Services/SecurityContextSource.php
+++ b/lib/Gocdb_Services/SecurityContextSource.php
@@ -20,4 +20,3 @@ public static function getContext(){
return self::$context;
}
}
-
diff --git a/lib/Gocdb_Services/ServiceService.php b/lib/Gocdb_Services/ServiceService.php
index 52f1029cf..451938274 100644
--- a/lib/Gocdb_Services/ServiceService.php
+++ b/lib/Gocdb_Services/ServiceService.php
@@ -19,6 +19,9 @@
require_once __DIR__ . '/RoleActionAuthorisationService.php';
require_once __DIR__ . '/Config.php';
+use org\gocdb\services\Config;
+use org\gocdb\services\Validate;
+
/**
* GOCDB Stateless service facade (business routines) for Service objects.
* The public API methods are atomic and transactional.
@@ -30,13 +33,17 @@
* @author George Ryall
* @author James McCarthy
*/
-class ServiceService extends AbstractEntityService {
- private $roleActionAuthorisationService;
+class ServiceService extends AbstractEntityService
+{
+ // roleActionAuthorisationService
+ private $roleAAS;
private $configService;
private $scopeService;
- function __construct(/* $roleActionAuthorisationService */) {
- parent::__construct ();
- // $this->roleActionAuthorisationService = $roleActionAuthorisationService;
+
+ public function __construct(/* $roleAAS */)
+ {
+ parent::__construct();
+ // $this->roleAAS = $roleActionAuthorisationService;
$this->configService = \Factory::getConfigService();
}
@@ -44,10 +51,11 @@ function __construct(/* $roleActionAuthorisationService */) {
* Set class dependency (REQUIRED).
*
* @todo Mandatory objects should be injected via constructor.
- * @param \org\gocdb\services\RoleActionAuthorisationService $roleActionAuthService
+ * @param \org\gocdb\services\RoleActionAuthorisationService $newService
*/
- public function setRoleActionAuthorisationService(RoleActionAuthorisationService $roleActionAuthService) {
- $this->roleActionAuthorisationService = $roleActionAuthService;
+ public function setRoleActionAuthorisationService(RoleActionAuthorisationService $newService)
+ {
+ $this->roleAAS = $newService;
}
/**
@@ -56,7 +64,8 @@ public function setRoleActionAuthorisationService(RoleActionAuthorisationService
* @todo Mandatory objects should be injected via constructor.
* @param \org\gocdb\services\Scope $scopeService
*/
- public function setScopeService(Scope $scopeService) {
+ public function setScopeService(Scope $scopeService)
+ {
$this->scopeService = $scopeService;
}
@@ -66,19 +75,21 @@ public function setScopeService(Scope $scopeService) {
* @param int $id the service ID
* @return \Service a service object
*/
- public function getService($id) {
+ public function getService($id)
+ {
$dql = "SELECT s FROM Service s
WHERE s.id = :id";
- $service = $this->em->createQuery ( $dql )->setParameter ( 'id', $id )->getSingleResult ();
+ $service = $this->em->createQuery($dql)->setParameter('id', $id)->getSingleResult();
return $service;
}
- public function getEndpoint($id) {
+ public function getEndpoint($id)
+ {
$dql = "SELECT el FROM EndpointLocation el
WHERE el.id = :id";
- $endpoint = $this->em->createQuery ( $dql )->setParameter ( 'id', $id )->getSingleResult ();
+ $endpoint = $this->em->createQuery($dql)->setParameter('id', $id)->getSingleResult();
return $endpoint;
}
@@ -103,11 +114,41 @@ public function getEndpoint($id) {
* false to return a hydrated Doctine object graph
* @return type array graph or object graph of {@link \Service} entities
*/
- public function getSes($term = null, $serviceType = null, $production = null, $monitored = null, $scope = null, $ngi = null, $certStatus = null, $showClosed = null, $servKeyNames = null, $servKeyValues = null, $startRecord = null, $endRecord = null, $returnArray = false) {
+ public function getSes(
+ $term = null,
+ $serviceType = null,
+ $production = null,
+ $monitored = null,
+ $scope = null,
+ $ngi = null,
+ $certStatus = null,
+ $showClosed = null,
+ $servKeyNames = null,
+ $servKeyValues = null,
+ $startRecord = null,
+ $endRecord = null,
+ $returnArray = false
+ ) {
// this method needs to be dropped in favor of getServicesFilterByParams,
// but it is still needed when adding services to serviceGroups.
- return $this->getServicesHelper ( $term, $serviceType, $production, $monitored, $scope, $ngi, $certStatus, $showClosed, $servKeyNames, $servKeyValues, $startRecord, $endRecord, $returnArray, false );
+
+ return $this->getServicesHelper(
+ $term,
+ $serviceType,
+ $production,
+ $monitored,
+ $scope,
+ $ngi,
+ $certStatus,
+ $showClosed,
+ $servKeyNames,
+ $servKeyValues,
+ $startRecord,
+ $endRecord,
+ $returnArray,
+ false
+ );
}
/**
@@ -115,65 +156,131 @@ public function getSes($term = null, $serviceType = null, $production = null, $m
* search parameters.
* {@link getSes}
*/
- public function getSesCount($term = null, $serviceType = null, $production = null, $monitored = null, $scope = null, $ngi = null, $certStatus = null, $showClosed = null, $servKeyNames = null, $servKeyValues = null, $startRecord = null, $endRecord = null, $returnArray = false) {
- return $this->getServicesHelper ( $term, $serviceType, $production, $monitored, $scope, $ngi, $certStatus, $showClosed, $servKeyNames, $servKeyValues, $startRecord, $endRecord, $returnArray, true );
+
+
+ public function getSesCount(
+ $term = null,
+ $serviceType = null,
+ $production = null,
+ $monitored = null,
+ $scope = null,
+ $ngi = null,
+ $certStatus = null,
+ $showClosed = null,
+ $servKeyNames = null,
+ $servKeyValues = null,
+ $startRecord = null,
+ $endRecord = null,
+ $returnArray = false
+ ) {
+
+ return $this->getServicesHelper(
+ $term,
+ $serviceType,
+ $production,
+ $monitored,
+ $scope,
+ $ngi,
+ $certStatus,
+ $showClosed,
+ $servKeyNames,
+ $servKeyValues,
+ $startRecord,
+ $endRecord,
+ $returnArray,
+ true
+ );
}
- private function getServicesHelper($term = null, $serviceType = null, $production = null, $monitored = null, $scope = null, $ngi = null, $certStatus = null, $showClosed = null, $servKeyNames = null, $servKeyValues = null, $startRecord = null, $endRecord = null, $returnArray = false, $count = false) {
+ private function getServicesHelper(
+ $term = null,
+ $serviceType = null,
+ $production = null,
+ $monitored = null,
+ $scope = null,
+ $ngi = null,
+ $certStatus = null,
+ $showClosed = null,
+ $servKeyNames = null,
+ $servKeyValues = null,
+ $startRecord = null,
+ $endRecord = null,
+ $returnArray = false,
+ $count = false
+ ) {
// this method can be dropped when getSes and getSesCount have been dropped.
if ($production == "TRUE") {
$production = "1";
- } else if ($production == "FALSE") {
+ } elseif ($production == "FALSE") {
$production = "0";
}
if ($monitored == "TRUE") {
$monitored = "1";
- } else if ($monitored == "FALSE") {
+ } elseif ($monitored == "FALSE") {
$monitored = "0";
}
- $qb = $this->em->createQueryBuilder ();
+ $qbr = $this->em->createQueryBuilder();
if ($count) {
- $qb->select ( 'count(DISTINCT se)' );
+ $qbr->select('count(DISTINCT se)');
} else {
- $qb->select ( 'DISTINCT se', 'si', 'st', 'cs', 'n' );
+ $qbr->select('DISTINCT se', 'si', 'st', 'cs', 'n');
}
- $qb->from ( 'Service', 'se' )->leftjoin ( 'se.serviceType', 'st' )->leftjoin ( 'se.scopes', 's' )->leftjoin ( 'se.parentSite', 'si' )->leftjoin ( 'si.certificationStatus', 'cs' )->leftjoin ( 'si.ngi', 'n' )->orderBy ( 'se.hostName' );
+ $qbr->from('Service', 'se')
+ ->leftjoin('se.serviceType', 'st')
+ ->leftjoin('se.scopes', 's')
+ ->leftjoin('se.parentSite', 'si')
+ ->leftjoin('si.certificationStatus', 'cs')
+ ->leftjoin('si.ngi', 'n')
+ ->orderBy('se.hostName');
// For use with search function, convert all terms to upper and do a like query
+
if ($term != null && $term != '%%') {
- $qb->andWhere ( $qb->expr ()->orX ( $qb->expr ()->like ( $qb->expr ()->upper ( 'se.hostName' ), ':term' ), $qb->expr ()->like ( $qb->expr ()->upper ( 'se.description' ), ':term' ) ) )->setParameter ( ':term', strtoupper ( $term ) );
+ $qbr->andWhere($qbr->expr()->orX(
+ $qbr->expr()->like($qbr->expr()->upper('se.hostName'), ':term'),
+ $qbr->expr()->like($qbr->expr()->upper('se.description'), ':term')
+ ))->setParameter(':term', strtoupper($term));
}
if ($serviceType != null && $serviceType != '%%') {
- $qb->andWhere ( $qb->expr ()->like ( $qb->expr ()->upper ( 'st.name' ), ':serviceType' ) )->setParameter ( ':serviceType', strtoupper ( $serviceType ) );
+ $qbr->andWhere($qbr->expr()->like(
+ $qbr->expr()->upper('st.name'),
+ ':serviceType'
+ ))->setParameter(':serviceType', strtoupper($serviceType));
}
if ($production != null && $production != '%%') {
- $qb->andWhere ( $qb->expr ()->like ( $qb->expr ()->upper ( 'se.production' ), ':production' ) )->setParameter ( ':production', $production );
+ $qbr->andWhere($qbr->expr()->like($qbr->expr()->upper('se.production'), ':production'))
+ ->setParameter(':production', $production);
}
if ($monitored != null && $monitored != '%%') {
- $qb->andWhere ( $qb->expr ()->like ( $qb->expr ()->upper ( 'se.monitored' ), ':monitored' ) )->setParameter ( ':monitored', $monitored );
+ $qbr->andWhere($qbr->expr()->like($qbr->expr()->upper('se.monitored'), ':monitored'))
+ ->setParameter(':monitored', $monitored);
}
if ($scope != null && $scope != '%%') {
- $qb->andWhere ( $qb->expr ()->like ( 's.name', ':scope' ) )->setParameter ( ':scope', $scope );
+ $qbr->andWhere($qbr->expr()->like('s.name', ':scope'))
+ ->setParameter(':scope', $scope);
}
if ($certStatus != null && $certStatus != '%%') {
- $qb->andWhere ( $qb->expr ()->like ( 'cs.name', ':certStatus' ) )->setParameter ( ':certStatus', $certStatus );
+ $qbr->andWhere($qbr->expr()->like('cs.name', ':certStatus'))
+ ->setParameter(':certStatus', $certStatus);
}
if ($showClosed != 1) {
- $qb->andWhere ( $qb->expr ()->not ( $qb->expr ()->like ( 'cs.name', ':closed' ) ) )->setParameter ( ':closed', 'Closed' );
+ $qbr->andWhere($qbr->expr()->not($qbr->expr()->like('cs.name', ':closed')))
+ ->setParameter(':closed', 'Closed');
}
if ($ngi != null && $ngi != '%%') {
- $qb->andWhere ( $qb->expr ()->like ( 'n.name', ':ngi' ) )->setParameter ( ':ngi', $ngi );
+ $qbr->andWhere($qbr->expr()->like('n.name', ':ngi'))
+ ->setParameter(':ngi', $ngi);
}
if ($servKeyNames != null && $servKeyNames != '%%') {
@@ -181,46 +288,53 @@ private function getServicesHelper($term = null, $serviceType = null, $productio
$servKeyValues = '%%';
}
- $sQ = $this->em->createQueryBuilder ();
- $sQ->select ( 'se1' . '.id' )->from ( 'Service', 'se1' )->join ( 'se1.serviceProperties', 'sp' )->andWhere ( $sQ->expr ()->andX ( $sQ->expr ()->eq ( 'sp.keyName', ':keyname' ), $sQ->expr ()->like ( 'sp.keyValue', ':keyvalue' ) ) );
+ $sqbr = $this->em->createQueryBuilder();
+ $sqbr->select('se1' . '.id')
+ ->from('Service', 'se1')
+ ->join('se1.serviceProperties', 'sp')
+ ->andWhere($sqbr->expr()
+ ->andX(
+ $sqbr->expr()->eq('sp.keyName', ':keyname'),
+ $sqbr->expr()->like('sp.keyValue', ':keyvalue')
+ ));
- $qb->andWhere ( $qb->expr ()->in ( 'se', $sQ->getDQL () ) );
- $qb->setParameter ( ':keyname', $servKeyNames )->setParameter ( ':keyvalue', $servKeyValues );
+ $qbr->andWhere($qbr->expr()->in('se', $sqbr->getDQL()));
+ $qbr->setParameter(':keyname', $servKeyNames)->setParameter(':keyvalue', $servKeyValues);
}
- $query = $qb->getQuery ();
+ $query = $qbr->getQuery();
if ($count) {
- $count = $query->getSingleScalarResult ();
+ $count = $query->getSingleScalarResult();
return $count;
} else {
-
- if (! empty ( $startRecord )) {
- $query->setFirstResult ( $startRecord );
+ if (! empty($startRecord)) {
+ $query->setFirstResult($startRecord);
}
- if (! empty ( $endRecord )) {
- $query->setMaxResults ( $endRecord );
+ if (! empty($endRecord)) {
+ $query->setMaxResults($endRecord);
}
if ($returnArray) {
- $results = $query->getResult ( \Doctrine\ORM\Query::HYDRATE_ARRAY );
+ $results = $query->getResult(\Doctrine\ORM\Query::HYDRATE_ARRAY);
return $results;
} else {
- $results = $query->getResult ();
+ $results = $query->getResult();
return $results;
}
// print_r($results);
}
}
- public function getAllSesJoinParentSites() {
+ public function getAllSesJoinParentSites()
+ {
$dql = "SELECT se, st, si
FROM Service se
JOIN se.serviceType st
JOIN se.parentSite si";
- $query = $this->em->createQuery ( $dql );
- return $query->getResult ();
+ $query = $this->em->createQuery($dql);
+ return $query->getResult();
}
/**
@@ -253,7 +367,8 @@ public function getAllSesJoinParentSites() {
* @return mixed Array of {@link \Service} entities or int representing
* the service count
*/
- public function getServicesFilterByParams($filterParams) {
+ public function getServicesFilterByParams($filterParams)
+ {
$searchTerm = null;
$serviceType = null;
$production = null;
@@ -269,151 +384,177 @@ public function getServicesFilterByParams($filterParams) {
$returnArray = false;
$count = false;
- if (isset ( $filterParams ['searchTerm'] )) {
+ if (isset($filterParams ['searchTerm'])) {
$searchTerm = $filterParams ['searchTerm'];
}
- if (isset ( $filterParams ['serviceType'] )) {
+ if (isset($filterParams ['serviceType'])) {
$serviceType = $filterParams ['serviceType'];
}
- if (isset ( $filterParams ['production'] )) {
- if (strtoupper ( $filterParams ['production'] ) == "TRUE") {
+ if (isset($filterParams ['production'])) {
+ if (strtoupper($filterParams ['production']) == "TRUE") {
$production = "1";
- } else if (strtoupper ( $filterParams ['production'] ) == "FALSE") {
+ } elseif (strtoupper($filterParams ['production']) == "FALSE") {
$production = "0";
}
}
- if (isset ( $filterParams ['monitored'] )) {
- if (strtoupper ( $filterParams ['monitored'] ) == "TRUE") {
+ if (isset($filterParams ['monitored'])) {
+ if (strtoupper($filterParams ['monitored']) == "TRUE") {
$monitored = "1";
- } else if (strtoupper ( $filterParams ['monitored'] ) == "FALSE") {
+ } elseif (strtoupper($filterParams ['monitored']) == "FALSE") {
$monitored = "0";
}
}
- if (isset ( $filterParams ['scope'] )) {
+ if (isset($filterParams ['scope'])) {
$scope = $filterParams ['scope'];
$scopeMatch = 'all';
}
- if (isset ( $filterParams ['scopeMatch'] )) {
+ if (isset($filterParams ['scopeMatch'])) {
$scopeMatch = $filterParams ['scopeMatch'];
}
- if (isset ( $filterParams ['ngi'] )) {
+ if (isset($filterParams ['ngi'])) {
$ngi = $filterParams ['ngi'];
}
- if (isset ( $filterParams ['certStatus'] )) {
+ if (isset($filterParams ['certStatus'])) {
$certStatus = $filterParams ['certStatus'];
}
- if (isset ( $filterParams ['showClosed'] ) && $filterParams ['showClosed'] == TRUE) {
+ if (isset($filterParams ['showClosed']) && $filterParams ['showClosed'] == true) {
$showClosed = $filterParams ['showClosed'];
}
- if (isset ( $filterParams ['servKeyNames'] )) {
+ if (isset($filterParams ['servKeyNames'])) {
$servKeyNames = $filterParams ['servKeyNames'];
}
- if (isset ( $filterParams ['servKeyValue'] )) {
+ if (isset($filterParams ['servKeyValue'])) {
$servKeyValue = $filterParams ['servKeyValue'];
}
- if (isset ( $filterParams ['startRecord'] )) {
+ if (isset($filterParams ['startRecord'])) {
$startRecord = $filterParams ['startRecord'];
}
- if (isset ( $filterParams ['maxResults'] )) {
+ if (isset($filterParams ['maxResults'])) {
$maxResults = $filterParams ['maxResults'];
}
- if (isset ( $filterParams ['returnArray'] )) {
+ if (isset($filterParams ['returnArray'])) {
$returnArray = $filterParams ['returnArray'];
}
- if (isset ( $filterParams ['count'] ) && $filterParams ['count'] != null) {
+ if (isset($filterParams ['count']) && $filterParams ['count'] != null) {
$count = $filterParams ['count'];
}
// bind count - used to create positional bind params.
- $bc = - 1;
- $qb = $this->em->createQueryBuilder ();
+ $bCount = - 1;
+ $qbr = $this->em->createQueryBuilder();
if ($count) {
- $qb->select ( 'count(DISTINCT se)' );
+ $qbr->select('count(DISTINCT se)');
} else {
- $qb->select ( 'DISTINCT se', 'si', 'st', 'cs', 'n' );
+ $qbr->select('DISTINCT se', 'si', 'st', 'cs', 'n');
}
- $qb->from ( 'Service', 'se' )->leftjoin ( 'se.serviceType', 'st' )->leftjoin ( 'se.scopes', 's' )->leftjoin ( 'se.parentSite', 'si' )->leftjoin ( 'si.certificationStatus', 'cs' )->leftjoin ( 'si.ngi', 'n' )->orderBy ( 'se.hostName' );
+ $qbr->from('Service', 'se')
+ ->leftjoin('se.serviceType', 'st')
+ ->leftjoin('se.scopes', 's')
+ ->leftjoin('se.parentSite', 'si')
+ ->leftjoin('si.certificationStatus', 'cs')
+ ->leftjoin('si.ngi', 'n')
+ ->orderBy('se.hostName');
// For use with search function, convert all terms to upper and do a like query
+
if ($searchTerm != null) {
- $qb->andWhere ( $qb->expr ()->orX ( $qb->expr ()->like ( $qb->expr ()->upper ( 'se.hostName' ), '?' . ++ $bc ), $qb->expr ()->like ( $qb->expr ()->upper ( 'se.description' ), '?' . $bc ) ) )->setParameter ( $bc, strtoupper ( $searchTerm ) );
+ $qbr->andWhere($qbr->expr()
+ ->orX(
+ $qbr->expr()->like(
+ $qbr->expr()->upper('se.hostName'),
+ '?' . ++$bCount
+ ),
+ $qbr->expr()->like($qbr->expr()->upper('se.description'), '?' . $bCount)
+ ))->setParameter($bCount, strtoupper($searchTerm));
}
if ($serviceType != null) {
- $qb->andWhere ( $qb->expr ()->like ( $qb->expr ()->upper ( 'st.name' ), '?' . ++ $bc ) )->setParameter ( $bc, strtoupper ( $serviceType ) );
+ $qbr->andWhere($qbr->expr()->like($qbr->expr()->upper('st.name'), '?' . ++$bCount))
+ ->setParameter($bCount, strtoupper($serviceType));
}
if ($production != null) {
- $qb->andWhere ( $qb->expr ()->like ( $qb->expr ()->upper ( 'se.production' ), '?' . ++ $bc ) )->setParameter ( $bc, $production );
+ $qbr->andWhere($qbr->expr()->like($qbr->expr()->upper('se.production'), '?' . ++$bCount))
+ ->setParameter($bCount, $production);
}
if ($monitored != null) {
- $qb->andWhere ( $qb->expr ()->like ( $qb->expr ()->upper ( 'se.monitored' ), '?' . ++ $bc ) )->setParameter ( $bc, $monitored );
+ $qbr->andWhere($qbr->expr()->like($qbr->expr()->upper('se.monitored'), '?' . ++$bCount))
+ ->setParameter($bCount, $monitored);
}
// Create WHERE clauses for multiple scopes using positional bind params
if ($scope != null) {
require_once __DIR__ . '/PI/QueryBuilders/ScopeQueryBuilder.php';
- $scopeQueryBuilder = new ScopeQueryBuilder ( $scope, $scopeMatch, $qb, $this->em, $bc, 'Service', 'se' );
+ $scopeQueryBuilder = new ScopeQueryBuilder($scope, $scopeMatch, $qbr, $this->em, $bCount, 'Service', 'se');
// Get the result of the scope builder
- /* @var $qb \Doctrine\ORM\QueryBuilder */
- $qb = $scopeQueryBuilder->getQB ();
- $bc = $scopeQueryBuilder->getBindCount ();
+ /* @var $qbr \Doctrine\ORM\QueryBuilder */
+ $qbr = $scopeQueryBuilder->getQB();
+ $bCount = $scopeQueryBuilder->getBindCount();
// Get the binds and store them in the local bind array only if any binds are fetched from scopeQueryBuilder
- $binds = ( array ) $scopeQueryBuilder->getBinds ();
- foreach ( $binds as $bind ) {
+ $binds = (array) $scopeQueryBuilder->getBinds();
+ foreach ($binds as $bind) {
$binds [] = $bind;
}
- foreach ( $binds as $bindIdValue ) {
- $qb->setParameter ( $bindIdValue [0], $bindIdValue [1] ); // , \Doctrine\DBAL\Types\Type::STRING );
+ foreach ($binds as $bindIdValue) {
+ $qbr->setParameter($bindIdValue [0], $bindIdValue [1]); // , \Doctrine\DBAL\Types\Type::STRING );
}
}
if ($certStatus != null) {
- $qb->andWhere ( $qb->expr ()->like ( 'cs.name', '?' . ++ $bc ) )->setParameter ( $bc, $certStatus );
+ $qbr->andWhere($qbr->expr()->like('cs.name', '?' . ++$bCount))->setParameter($bCount, $certStatus);
}
if ($showClosed) {
// don't add the extra where clause
} else {
// add a where clause to drop Closed certStatus, i.e. 'WHERE cs.name IS NOT LIKE Closed'
- $qb->andWhere ( $qb->expr ()->not ( $qb->expr ()->like ( 'cs.name', '?' . ++ $bc ) ) )->setParameter ( $bc, 'Closed' );
+ $qbr->andWhere($qbr->expr()->not($qbr->expr()->like('cs.name', '?' . ++$bCount)))
+ ->setParameter($bCount, 'Closed');
}
if ($ngi != null) {
- $qb->andWhere ( $qb->expr ()->like ( 'n.name', '?' . ++ $bc ) )->setParameter ( $bc, $ngi );
+ $qbr->andWhere($qbr->expr()->like('n.name', '?' . ++$bCount))
+ ->setParameter($bCount, $ngi);
}
if ($servKeyNames != null) {
if ($servKeyValue == null || $servKeyValue == '') {
$servKeyValue = '%%';
}
- $sQ = $this->em->createQueryBuilder ();
- $sQ->select ( 'se_p1' . '.id' )->from ( 'Service', 'se_p1' )->join ( 'se_p1.serviceProperties', 'sp' )->andWhere ( $sQ->expr ()->andX ( $sQ->expr ()->eq ( 'sp.keyName', '?' . ++ $bc ), $sQ->expr ()->like ( 'sp.keyValue', '?' . ++ $bc ) ) );
- $qb->andWhere ( $qb->expr ()->in ( 'se', $sQ->getDQL () ) );
- $qb->setParameter ( $bc - 1, $servKeyNames )->setParameter ( $bc, $servKeyValue );
+ $sqbr = $this->em->createQueryBuilder();
+ $sqbr->select('se_p1' . '.id')
+ ->from('Service', 'se_p1')
+ ->join('se_p1.serviceProperties', 'sp')
+ ->andWhere($sqbr->expr()->andX(
+ $sqbr->expr()->eq('sp.keyName', '?' . ++$bCount),
+ $sqbr->expr()->like('sp.keyValue', '?' . ++$bCount)
+ ));
+
+ $qbr->andWhere($qbr->expr()->in('se', $sqbr->getDQL()));
+ $qbr->setParameter($bCount - 1, $servKeyNames)->setParameter($bCount, $servKeyValue);
}
- $query = $qb->getQuery ();
+ $query = $qbr->getQuery();
if ($count) {
- $count = $query->getSingleScalarResult ();
+ $count = $query->getSingleScalarResult();
return $count;
} else {
- if (! empty ( $startRecord )) {
- $query->setFirstResult ( $startRecord );
+ if (! empty($startRecord)) {
+ $query->setFirstResult($startRecord);
}
- if (! empty ( $maxResults )) {
- $query->setMaxResults ( $maxResults );
+ if (! empty($maxResults)) {
+ $query->setMaxResults($maxResults);
}
if ($returnArray) {
- $results = $query->getResult ( \Doctrine\ORM\Query::HYDRATE_ARRAY );
+ $results = $query->getResult(\Doctrine\ORM\Query::HYDRATE_ARRAY);
return $results;
} else {
- $results = $query->getResult ();
+ $results = $query->getResult();
return $results;
}
// print_r($results);
@@ -426,13 +567,13 @@ public function getServicesFilterByParams($filterParams) {
* @param integer $id Service ID
* @param integer $dayLimit
*/
- public function getDowntimes($id, $dayLimit) {
+ public function getDowntimes($id, $dayLimit)
+ {
if ($dayLimit != null) {
- $di = \DateInterval::createFromDateString ( $dayLimit . 'days' );
- $dayLimit = new \DateTime ();
- $dayLimit->sub ( $di );
+ $dateInterval = \DateInterval::createFromDateString($dayLimit . 'days');
+ $dayLimit = new \DateTime();
+ $dayLimit->sub($dateInterval);
}
-
// Simplified and updated query for MEPs model by JM&DM - 18/06/2014
$dql = "SELECT d
FROM Downtime d
@@ -441,7 +582,10 @@ public function getDowntimes($id, $dayLimit) {
AND ( :dayLimit IS NULL OR d.startDate > :dayLimit)
ORDER BY d.startDate DESC";
- $downtimes = $this->em->createQuery ( $dql )->setParameter ( 'id', $id )->setParameter ( 'dayLimit', $dayLimit )->getResult ();
+ $downtimes = $this->em->createQuery($dql)
+ ->setParameter('id', $id)
+ ->setParameter('dayLimit', $dayLimit)
+ ->getResult();
// $downtimes = $this->getService($id)->getDowntimes();
return $downtimes;
@@ -452,10 +596,11 @@ public function getDowntimes($id, $dayLimit) {
*
* @return array $types An array of all ServiceType entities
*/
- public function getServiceTypes() {
+ public function getServiceTypes()
+ {
$dql = "SELECT st FROM ServiceType st
ORDER BY st.name";
- $types = $this->em->createQuery ( $dql )->getResult ();
+ $types = $this->em->createQuery($dql)->getResult();
return $types;
}
@@ -470,19 +615,27 @@ public function getServiceTypes() {
* is invalid. The \Exception's message will contain a human readable error
* message.
*/
- public function validateProductionMonitoredCombination($serviceTypeName, $production, $monitored) {
+ public function validateProductionMonitoredCombination($serviceType, $production, $monitored)
+ {
// Service types that are exceptions to the
// 'production => monitored' rule.
$ruleExceptions = array('VOMS', 'emi.ARGUS', 'org.squid-cache.Squid');
+ $serviceTypeName = $serviceType->getName();
// Check that the service type is not an exception to the
// 'production => monitored'.
- if (!in_array ($serviceTypeName, $ruleExceptions)) {
- if ($production && !$monitored) {
+ if ($production && !$monitored) {
+ // Legacy hard-coded rules (as of Jan-20) should be removed
+ if (
+ !in_array($serviceTypeName, $ruleExceptions) and
+ !$serviceType->getAllowMonitoringException()
+ ) {
throw new \Exception(
- "For the '".$serviceTypeName."' service type, if the ".
- "Production flag is set to True, the Monitored flag must ".
- "also be True.");
+ "For the '" . $serviceTypeName . "' service type, if a " .
+ "service is in Production it must be Monitored. " .
+ "Contact GOCDB administrators if required to discuss " .
+ "changing this requirement."
+ );
}
}
}
@@ -491,7 +644,7 @@ public function validateProductionMonitoredCombination($serviceTypeName, $produc
* Updates a Service.
* Returns the updated SE
*
- * Accepts an array $se_data as a parameter. $se_data's format is as follows:
+ * Accepts an array $newValues as a parameter. $newValues's format is as follows:
*
* Array
* (
@@ -517,72 +670,88 @@ public function validateProductionMonitoredCombination($serviceTypeName, $produc
* )
*
*
- * @param array $se_data Array of updated service data, specified above.
- * return Service The updated service entity
+ * @param array $newValues Array of updated service data, specified above.
+ * @return \Service The updated service entity
*/
- public function editService(\Service $se, $newValues, \User $user = null) {
+ public function editService(\Service $service, $newValues, \User $user = null)
+ {
require_once __DIR__ . '/../../htdocs/web_portal/components/Get_User_Principle.php';
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ( $user );
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
+
// Authorise the change
- if ($this->roleActionAuthorisationService->authoriseAction ( \Action::EDIT_OBJECT, $se->getParentSite (), $user )->getGrantAction () == FALSE) {
- throw new \Exception ( "You do not have permission over this service." );
+ if (
+ $this->roleAAS->authoriseAction(
+ \Action::EDIT_OBJECT,
+ $service->getParentSite(),
+ $user
+ )->getGrantAction() == false
+ ) {
+ throw new \Exception("You do not have permission over this service.");
}
- $st = $this->getServiceType ( $newValues ['serviceType'] );
- $this->validate ( $newValues ['SE'], 'service' );
- $this->uniqueCheck ( $newValues ['SE'] ['HOSTNAME'], $st, $se->getParentSite () );
- // validate production/monitored combination
- $this->validateProductionMonitoredCombination(
- $this->getServiceType($newValues['serviceType']),
- $this->ptlTexToBool($newValues['PRODUCTION_LEVEL']),
- $this->ptlTexToBool($newValues['IS_MONITORED'])
- );
+ $servType = $this->getServiceType($newValues ['serviceType']);
+
+ $this->validate($newValues ['SE'], 'service');
+ $this->uniqueCheck($newValues ['SE'] ['HOSTNAME'], $servType, $service->getParentSite());
// EDIT SCOPE TAGS:
// collate selected scopeIds (reserved and non-reserved)
$scopeIdsToApply = array ();
- foreach ( $newValues ['Scope_ids'] as $sid ) {
+ foreach ($newValues ['Scope_ids'] as $sid) {
$scopeIdsToApply [] = $sid;
}
- foreach ( $newValues ['ReservedScope_ids'] as $sid ) {
+ foreach ($newValues ['ReservedScope_ids'] as $sid) {
$scopeIdsToApply [] = $sid;
}
- $selectedScopesToApply = $this->scopeService->getScopes ( $scopeIdsToApply );
+ $scopesToApply = $this->scopeService->getScopes($scopeIdsToApply);
// If not admin, Check user edits to the service's Reserved scopes:
// Required to prevent users manually crafting a POST request in an attempt
// to select reserved scopes, this is unlikely but it is a possible hack.
- if (! $user->isAdmin ()) {
- $selectedReservedScopes = $this->scopeService->getScopesFilterByParams ( array (
+ if (! $user->isAdmin()) {
+ $resScopesToApply = $this->scopeService->getScopesFilterByParams(array (
'excludeNonReserved' => true
- ), $selectedScopesToApply );
-
- $existingReservedScopes = $this->scopeService->getScopesFilterByParams ( array (
+ ), $scopesToApply);
+ // Existing reserved scopes
+ $resScopes = $this->scopeService->getScopesFilterByParams(array (
'excludeNonReserved' => true
- ), $se->getScopes ()->toArray () );
+ ), $service->getScopes()->toArray());
- $existingReservedScopesParent = $this->scopeService->getScopesFilterByParams ( array (
+ $resScopesParent = $this->scopeService->getScopesFilterByParams(array (
'excludeNonReserved' => true
- ), $se->getParentSite ()->getScopes ()->toArray () );
+ ), $service->getParentSite()->getScopes()->toArray());
- foreach ( $selectedReservedScopes as $sc ) {
+ foreach ($resScopesToApply as $sc) {
// Reserved scopes must already be assigned to se or parent
- if (! in_array ( $sc, $existingReservedScopes ) && ! in_array ( $sc, $existingReservedScopesParent )) {
- throw new \Exception ( "A reserved Scope Tag was selected that " . "is not assigned to the Service or to the Parent Site" );
+
+ if (! in_array($sc, $resScopes) && ! in_array($sc, $resScopesParent)) {
+ throw new \Exception("A reserved Scope Tag was selected that " .
+ "is not assigned to the Service or to the Parent Site");
}
}
}
// check there are the required number of optional scopes specified
- $this->checkNumberOfScopes ( $this->scopeService->getScopesFilterByParams ( array (
- 'excludeReserved' => true
- ), $selectedScopesToApply ) );
- $updatedServiceValues =array();
+ $this->checkNumberOfScopes(
+ $this->scopeService->getScopesFilterByParams(
+ array('excludeReserved' => true),
+ $scopesToApply
+ )
+ );
+
+ // validate production/monitored combination
+ $this->validateProductionMonitoredCombination(
+ $servType,
+ $this->ptlTexToBool($newValues['PRODUCTION_LEVEL']),
+ $this->ptlTexToBool($newValues['IS_MONITORED'])
+ );
+
+ $updatedServiceValues = array();
$updatedServiceValues['hostname'] = $newValues ['SE'] ['HOSTNAME'];
$updatedServiceValues['description'] = $newValues ['SE'] ['DESCRIPTION'];
$updatedServiceValues['url'] = $newValues['SE']['URL'];
@@ -595,31 +764,29 @@ public function editService(\Service $se, $newValues, \User $user = null) {
$updatedServiceValues['monitored'] = $this->ptlTexToBool($newValues['IS_MONITORED']);
$updatedServiceValues['beta'] = $this->ptlTexToBool($newValues['BETA']);
$updatedServiceValues['production'] = $this->ptlTexToBool($newValues['PRODUCTION_LEVEL']);
- $updatedServiceValues['notify'];
- if (!isset($newValues['NOTIFY'])){
+ if (!isset($newValues['NOTIFY'])) {
$updatedServiceValues['notify'] = false;
- }
- else {
+ } else {
$updatedServiceValues['notify'] = $this->ptlTexToBool($newValues['NOTIFY']);
}
- $this->editServiceLogic($se, $selectedScopesToApply, $st, $updatedServiceValues);
+ $this->editServiceLogic($service, $scopesToApply, $servType, $updatedServiceValues);
- return $se;
+ return $service;
}
/**
* Function called by write API to edit a service. Provides API specific
* authorisation on top of shared logic with web portal
- * @param Service $service service being updated
+ * @param \Service $service service being updated
* @param string $hostname service hostname
* @param string $description service description
* @param string $url service url
* @param string $dn service dn
- * @param string $ip service IP
+ * @param string $ip4 service IP (ipV4)
* @param string $ip6 serviec IP (ipV6)
- * @param string $os service OS
+ * @param string $opSys service OS
* @param string $email service email
* @param string $arch service archetecture
* @param string $monitored
@@ -629,42 +796,59 @@ public function editService(\Service $se, $newValues, \User $user = null) {
* @param string $authIdentifierType
* @param string $authIdentifier
*/
- public function editServiceApi(\Service $service, $hostname, $description, $url, $dn, $ip, $ip6, $os, $email, $arch, $monitored, $beta, $production, $notify, $authIdentifierType, $authIdentifier) {
+
+ public function editServiceApi(
+ \Service $service,
+ $hostname,
+ $description,
+ $url,
+ $dn,
+ $ip4,
+ $ip6,
+ $opSys,
+ $email,
+ $arch,
+ $monitored,
+ $beta,
+ $production,
+ $notify,
+ $authIdentifierType,
+ $authIdentifier
+ ) {
//Check the portal is not in read only mode, throws exception if it is
- $this->checkGOCDBIsNotReadOnly();
-
- $this->checkAuthorisedAPIIdentifier($service->getParentSite(), $authIdentifier, $authIdentifierType);
-
- $scopes = clone $service->getScopes();
- $sType = $service->getServiceType();
- $updatedServiceValues = array (
- 'hostname'=>$hostname,
- 'description'=>$description,
- 'url'=>$url,
- 'dn'=>$dn,
- 'ip'=>$ip,
- 'ip6'=>$ip6,
- 'os'=>$os,
- 'email'=>$email,
- 'arch'=>$arch,
- 'monitored'=>$monitored,
- 'beta'=>$beta,
- 'production'=>$production,
- 'notify'=>$notify,
- );
-
- $this->validateProductionMonitoredCombination($service->getServiceType()->getName(), $production, $monitored);
-
- $this->editServiceLogic($service, $scopes, $sType, $updatedServiceValues);
- }
+ $this->checkGOCDBIsNotReadOnly();
+
+ $this->checkAuthorisedAPIIdentifier($service->getParentSite(), $authIdentifier, $authIdentifierType);
+
+ $scopes = clone $service->getScopes();
+ $sType = $service->getServiceType();
+ $updatedServiceValues = array (
+ 'hostname' => $hostname,
+ 'description' => $description,
+ 'url' => $url,
+ 'dn' => $dn,
+ 'ip' => $ip4,
+ 'ip6' => $ip6,
+ 'os' => $opSys,
+ 'email' => $email,
+ 'arch' => $arch,
+ 'monitored' => $monitored,
+ 'beta' => $beta,
+ 'production' => $production,
+ 'notify' => $notify,
+ );
+ $this->validateProductionMonitoredCombination($service->getServiceType(), $production, $monitored);
+
+ $this->editServiceLogic($service, $scopes, $sType, $updatedServiceValues);
+ }
/**
* The logic of editing a service, without the authorisation or validation.
* Private function as there should always be authorisation anad validation
* steps within the service before calling this function.
*
- * @param Service $service service to be updated
+ * @param \Service $service service to be updated
* @param array $scopes scopes of service being updated
* @param $sType service type of service
* @param array $updatedServiceValues values being updated for $service. Should contain:
@@ -674,7 +858,7 @@ public function editServiceApi(\Service $service, $hostname, $description, $url,
* ['dn'] dn of service being updated
* ['$ip6'] ip V6 of service being updated
* ['ip'] ip of service being updated
- * ['$os'] os of service being updated
+ * ['os'] os of service being updated
* ['email'] email of service being updated
* ['$arch'] architecture of service being updated
* ['$monitored'] boolean monitored of service being updated
@@ -683,78 +867,80 @@ public function editServiceApi(\Service $service, $hostname, $description, $url,
* ['$notify'] boolean notify value of service being updated
* @throws Exception
*/
- private function editServiceLogic(\Service $service, $scopes, $sType, $updatedServiceValues){
+ private function editServiceLogic(\Service $service, $scopes, $sType, $updatedServiceValues)
+ {
// Explicitly demarcate our tx boundary
- $this->em->getConnection ()->beginTransaction ();
- try {
- // Set the service's member variables
- $service->setHostName($updatedServiceValues['hostname']);
- $service->setDescription($updatedServiceValues['description']);
- $service->setUrl($updatedServiceValues['url']);
- $service->setDn($updatedServiceValues['dn']);
- $service->setIpAddress($updatedServiceValues['ip']);
- $service->setIpV6Address($updatedServiceValues['ip6']);
- $service->setOperatingSystem($updatedServiceValues['os']);
- $service->setEmail($updatedServiceValues['email']);
- $service->setArchitecture($updatedServiceValues['arch']);
- $service->setMonitored($updatedServiceValues['monitored']);
- $service->setBeta($updatedServiceValues['beta']);
- $service->setProduction($updatedServiceValues['production']);
- $service->setNotify($updatedServiceValues['notify']);
-
- $service->setServiceType($sType);
-
- // Update the scope of the service
- // firstly remove all existing scope links
- $oldScopes = $service->getScopes ();
- foreach($oldScopes as $s ) {
- $service->removeScope($s);
- }
-
- // find each specified scope and then link it to the specified site
- foreach($scopes as $scope) {
- $service->addScope($scope);
- }
-
- $this->em->merge($service);
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $e ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
- throw $e;
- }
+ $this->em->getConnection()->beginTransaction();
+ try {
+ // Set the service's member variables
+ $service->setHostName($updatedServiceValues['hostname']);
+ $service->setDescription($updatedServiceValues['description']);
+ $service->setUrl($updatedServiceValues['url']);
+ $service->setDn($updatedServiceValues['dn']);
+ $service->setIpAddress($updatedServiceValues['ip']);
+ $service->setIpV6Address($updatedServiceValues['ip6']);
+ $service->setOperatingSystem($updatedServiceValues['os']);
+ $service->setEmail($updatedServiceValues['email']);
+ $service->setArchitecture($updatedServiceValues['arch']);
+ $service->setMonitored($updatedServiceValues['monitored']);
+ $service->setBeta($updatedServiceValues['beta']);
+ $service->setProduction($updatedServiceValues['production']);
+ $service->setNotify($updatedServiceValues['notify']);
+
+ $service->setServiceType($sType);
+
+ // Update the scope of the service
+ // firstly remove all existing scope links
+ $oldScopes = $service->getScopes();
+ foreach ($oldScopes as $scope) {
+ $service->removeScope($scope);
+ }
+
+ // find each specified scope and then link it to the specified site
+ foreach ($scopes as $scope) {
+ $service->addScope($scope);
+ }
+
+ $this->em->merge($service);
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
+ throw $e;
+ }
}
/**
* Validates user inputted service data against the
* checks in the gocdb_schema.xml.
*
- * @param array $se_data containing all the fields for a Service
+ * @param array $seData containing all the fields for a Service
* @throws \Exception If the SE data can't be
* validated. The \Exception message will contain a human
* readable description of which field failed validation.
* @return null
*/
- private function validate($se_data, $type) {
+ private function validate($seData, $type)
+ {
require_once __DIR__ . '/Validate.php';
- $serv = new \org\gocdb\services\Validate ();
- foreach ( $se_data as $field => $value ) {
- $valid = $serv->validate ( $type, $field, $value );
+ $serv = new Validate();
+ foreach ($seData as $field => $value) {
+ $valid = $serv->validate($type, $field, $value);
if (! $valid) {
$error = "$field contains an invalid value: $value";
- throw new \Exception ( $error );
+ throw new \Exception($error);
}
}
// Apply additional logic for validation that can't be captured solely using gocdb_schema.xml
- if (! empty ( $se_data ['HOST_IP_V6'] )) {
+ if (! empty($seData ['HOST_IP_V6'])) {
require_once __DIR__ . '/validation/IPv6Validator.php';
- $validator = new \IPv6Validator ();
+ $validator = new \IPv6Validator();
$errors = array ();
- $errors = $validator->validate ( $se_data ['HOST_IP_V6'], $errors );
- if (count ( $errors ) > 0) {
- throw new \Exception ( $errors [0] ); // show the first message.
+ $errors = $validator->validate($seData ['HOST_IP_V6'], $errors);
+ if (count($errors) > 0) {
+ throw new \Exception($errors [0]); // show the first message.
}
}
}
@@ -788,86 +974,86 @@ private function validate($se_data, $type) {
* @param Array $values Balues for the new SE (defined above)
* @param org\gocdb\services\User $user The user adding the SE
*/
- public function addService($values, \User $user = null) {
+ public function addService($values, \User $user = null)
+ {
// get the parent site
$dql = "SELECT s from Site s WHERE s.id = :id";
/* @var $site \Site */
- $site = $this->em->createQuery ( $dql )->setParameter ( 'id', $values ['hostingSite'] )->getSingleResult ();
+ $site = $this->em->createQuery($dql)->setParameter('id', $values ['hostingSite'])->getSingleResult();
// get the service type
- $st = $this->getServiceType ( $values ['serviceType'] );
+ $servType = $this->getServiceType($values ['serviceType']);
- if ($this->roleActionAuthorisationService->authoriseAction ( \Action::SITE_ADD_SERVICE, $site, $user )->getGrantAction () == FALSE) {
- throw new \Exception ( "You don't have permission to add a service to this site." );
+ if ($this->roleAAS->authoriseAction(\Action::SITE_ADD_SERVICE, $site, $user)->getGrantAction() == false) {
+ throw new \Exception("You don't have permission to add a service to this site.");
}
- $this->validate ( $values ['SE'], 'service' );
- $this->uniqueCheck ( $values ['SE'] ['HOSTNAME'], $st, $site );
-
- // validate production/monitored combination
- $this->validateProductionMonitoredCombination(
- $this->getServiceType($values['serviceType']),
- $this->ptlTexToBool($values['PRODUCTION_LEVEL']),
- $this->ptlTexToBool($values['IS_MONITORED'])
- );
+ $this->validate($values ['SE'], 'service');
+ $this->uniqueCheck($values ['SE'] ['HOSTNAME'], $servType, $site);
// ADD SCOPE TAGS:
// collate selected reserved and non-reserved scopeIds.
// Note, Reserved scopes can be inherited from the parent Site.
$allSelectedScopeIds = array ();
- foreach ( $values ['Scope_ids'] as $sid ) {
+ foreach ($values ['Scope_ids'] as $sid) {
$allSelectedScopeIds [] = $sid;
}
- foreach ( $values ['ReservedScope_ids'] as $sid ) {
+ foreach ($values ['ReservedScope_ids'] as $sid) {
$allSelectedScopeIds [] = $sid;
}
- $selectedScopesToApply = $this->scopeService->getScopes ( $allSelectedScopeIds );
+ $scopesToApply = $this->scopeService->getScopes($allSelectedScopeIds);
// If not admin, check that requested reserved scopes are already implemented by the parent Site.
// Required to prevent users manually crafting a POST request in an attempt
// to select reserved scopes, this is unlikely but it is a possible hack.
- if (! $user->isAdmin ()) {
- $selectedReservedScopes = $this->scopeService->getScopesFilterByParams ( array (
+ if (! $user->isAdmin()) {
+ $resScopesToApply = $this->scopeService->getScopesFilterByParams(array (
'excludeNonReserved' => true
- ), $selectedScopesToApply );
+ ), $scopesToApply);
- $existingReservedScopesParent = $this->scopeService->getScopesFilterByParams ( array (
+ $resScopesParent = $this->scopeService->getScopesFilterByParams(array (
'excludeNonReserved' => true
- ), $site->getScopes ()->toArray () );
+ ), $site->getScopes()->toArray());
- foreach ( $selectedReservedScopes as $sc ) {
+ foreach ($resScopesToApply as $sc) {
// Reserved scopes must already be assigned to parent
- if (! in_array ( $sc, $existingReservedScopesParent )) {
- throw new \Exception ( "A reserved Scope Tag was selected that is not assigned to the Parent Site" );
+ if (! in_array($sc, $resScopesParent)) {
+ throw new \Exception("A reserved Scope Tag was selected that is not assigned to the Parent Site");
}
}
}
// check there are the required number of OPTIONAL scopes specified
- $this->checkNumberOfScopes ( $values ['Scope_ids'] );
+ $this->checkNumberOfScopes($values ['Scope_ids']);
+
+ // validate production/monitored combination
+ $this->validateProductionMonitoredCombination(
+ $servType,
+ $this->ptlTexToBool($values['PRODUCTION_LEVEL']),
+ $this->ptlTexToBool($values['IS_MONITORED'])
+ );
- $this->em->getConnection ()->beginTransaction ();
+ $this->em->getConnection()->beginTransaction();
try {
- $se = new \Service ();
- $se->setParentSiteDoJoin ( $site );
- $se->setServiceType ( $st );
+ $serv = new \Service();
+ $serv->setParentSiteDoJoin($site);
+ $serv->setServiceType($servType);
// Set production
- $se->setProduction($this->ptlTexToBool($values['PRODUCTION_LEVEL']));
+ $serv->setProduction($this->ptlTexToBool($values['PRODUCTION_LEVEL']));
// Set Beta
- $se->setBeta($this->ptlTexToBool($values['BETA']));
+ $serv->setBeta($this->ptlTexToBool($values['BETA']));
// Set monitored
- $se->setMonitored($this->ptlTexToBool($values['IS_MONITORED']));
+ $serv->setMonitored($this->ptlTexToBool($values['IS_MONITORED']));
//Set notify flag for site
- if (!isset($values['NOTIFY'])){
- $se->setNotify(false);
- }
- else{
- $se->setNotify($this->ptlTexToBool($values['NOTIFY']));
+ if (!isset($values['NOTIFY'])) {
+ $serv->setNotify(false);
+ } else {
+ $serv->setNotify($this->ptlTexToBool($values['NOTIFY']));
}
// Set the scopes
@@ -876,30 +1062,30 @@ public function addService($values, \User $user = null) {
// $scope = $this->em->createQuery($dql)
// ->setParameter('id', $scopeId)
// ->getSingleResult();
- // $se->addScope($scope);
+ // $serv->addScope($scope);
// }
- foreach ( $selectedScopesToApply as $scope ) {
- $se->addScope ( $scope );
+ foreach ($scopesToApply as $scope) {
+ $serv->addScope($scope);
}
- $se->setDn ( $values ['SE'] ['HOST_DN'] );
- $se->setIpAddress ( $values ['SE'] ['HOST_IP'] );
- $se->setOperatingSystem ( $values ['SE'] ['HOST_OS'] );
- $se->setArchitecture ( $values ['SE'] ['HOST_ARCH'] );
- $se->setHostName ( $values ['SE'] ['HOSTNAME'] );
- $se->setDescription ( $values ['SE'] ['DESCRIPTION'] );
- $se->setEmail ( $values ['SE'] ['EMAIL'] );
- $se->setUrl ( $values ['SE'] ['URL'] );
-
- $this->em->persist ( $se );
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $e ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
+ $serv->setDn($values ['SE'] ['HOST_DN']);
+ $serv->setIpAddress($values ['SE'] ['HOST_IP']);
+ $serv->setOperatingSystem($values ['SE'] ['HOST_OS']);
+ $serv->setArchitecture($values ['SE'] ['HOST_ARCH']);
+ $serv->setHostName($values ['SE'] ['HOSTNAME']);
+ $serv->setDescription($values ['SE'] ['DESCRIPTION']);
+ $serv->setEmail($values ['SE'] ['EMAIL']);
+ $serv->setUrl($values ['SE'] ['URL']);
+
+ $this->em->persist($serv);
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
throw $e;
}
- return $se;
+ return $serv;
}
/**
@@ -913,11 +1099,12 @@ public function addService($values, \User $user = null) {
* (as explained by Rajesh Kalmady)
*
* @param string $hostName New hostname
- * @param ServiceType $serviceType New service type
- * @param Site $site The site to add the SE to
+ * @param \ServiceType $serviceType New service type
+ * @param \Site $site The site to add the SE to
* @return null
*/
- private function uniqueCheck($hostName, \ServiceType $serviceType, \Site $site) {
+ private function uniqueCheck($hostName, \ServiceType $serviceType, \Site $site)
+ {
// Get all existing services with this hostname and service type, not under this site
$dql = "SELECT se from Service se
JOIN se.serviceType st
@@ -925,29 +1112,15 @@ private function uniqueCheck($hostName, \ServiceType $serviceType, \Site $site)
WHERE se.hostName = :hostName
AND st.id = :stId
AND s.id != :siteId";
- $ses = $this->em->createQuery ( $dql )->setParameter ( 'hostName', $hostName )->setParameter ( 'stId', $serviceType->getId () )->setParameter ( 'siteId', $site->getId () )->getResult ();
-
- if (sizeof ( $ses ) != 0) {
- throw new \Exception ( "A $serviceType service named $hostName already exists." );
- }
- }
- /**
- * Check that if if the selected scope for this SE is EGI, the parent site
- * is also EGI
- *
- * @param Site $site The SE's parent site
- * @param Scope $scope The SE's new scope
- * @return null
- */
- private function scopeCheck(\Site $site, \Scope $scope) {
- // If the scope isn't EGI then don't raise an error
- if ($scope->getName () != 'EGI') {
- return;
- }
+ $ses = $this->em->createQuery($dql)
+ ->setParameter('hostName', $hostName)
+ ->setParameter('stId', $serviceType->getId())
+ ->setParameter('siteId', $site->getId())
+ ->getResult();
- if ($site->getScopes ()->first ()->getName () != "EGI") {
- throw new \Exception ( "For this service to be EGI scoped, $site must also be EGI scoped." );
+ if (sizeof($ses) != 0) {
+ throw new \Exception("A $serviceType service named $hostName already exists.");
}
}
@@ -957,19 +1130,21 @@ private function scopeCheck(\Site $site, \Scope $scope) {
* @param integer $id The service type ID
* @return \ServiceType
*/
- private function getServiceType($id) {
+ private function getServiceType($id)
+ {
$dql = "SELECT st FROM ServiceType st WHERE st.id = :id";
- $st = $this->em->createQuery ( $dql )->setParameter ( 'id', $id )->getSingleResult ();
- return $st;
+ $servType = $this->em->createQuery($dql)->setParameter('id', $id)->getSingleResult();
+ return $servType;
}
/**
*
* @return array of all properties for a service
*/
- public function getProperties($id) {
+ public function getProperties($id)
+ {
$dql = "SELECT p FROM ServiceProperty p WHERE p.parentSite = :ID";
- $properties = $this->em->createQuery ( $dql )->setParameter ( 'ID', $id )->getOneOrNullResult ();
+ $properties = $this->em->createQuery($dql)->setParameter('ID', $id)->getOneOrNullResult();
return $properties;
}
@@ -977,9 +1152,10 @@ public function getProperties($id) {
*
* @return a single service property or null if not found
*/
- public function getProperty($id) {
+ public function getProperty($id)
+ {
$dql = "SELECT p FROM ServiceProperty p WHERE p.id = :ID";
- $property = $this->em->createQuery ( $dql )->setParameter ( 'ID', $id )->getOneOrNullResult ();
+ $property = $this->em->createQuery($dql)->setParameter('ID', $id)->getOneOrNullResult();
return $property;
}
@@ -987,57 +1163,69 @@ public function getProperty($id) {
*
* @return a single service endpoint property or null if not foud
*/
- public function getEndpointProperty($id) {
+ public function getEndpointProperty($id)
+ {
$dql = "SELECT p FROM EndpointProperty p WHERE p.id = :ID";
- $property = $this->em->createQuery ( $dql )->setParameter ( 'ID', $id )->getOneOrNullResult ();
+ $property = $this->em->createQuery($dql)->setParameter('ID', $id)->getOneOrNullResult();
return $property;
}
/**
* @return \ServiceProperty a single service property
*/
- public function getServicePropertyByKeyAndParent($key, $parentService) {
+ public function getServicePropertyByKeyAndParent($key, $parentService)
+ {
$parentServiceID = $parentService->getId();
$dql = "SELECT p FROM ServiceProperty p WHERE p.keyName = :KEY AND p.parentService = :PARENTSERVICEID";
$property = $this->em
- ->createQuery ($dql)
- ->setParameter ('KEY', $key)
- ->setParameter ('PARENTSERVICEID', $parentServiceID)
- ->getOneOrNullResult ();
+ ->createQuery($dql)
+ ->setParameter('KEY', $key)
+ ->setParameter('PARENTSERVICEID', $parentServiceID)
+ ->getOneOrNullResult();
return $property;
}
/**
* @return \SiteProperty a single site property
*/
- public function getEndpointPropertyByKeyAndParent($key, $parentEndpoint) {
+ public function getEndpointPropertyByKeyAndParent($key, $parentEndpoint)
+ {
$parentEndpointID = $parentEndpoint->getId();
$dql = "SELECT p FROM EndpointProperty p WHERE p.keyName = :KEY AND p.parentEndpoint = :PARENTENDPOINTID";
$property = $this->em
- ->createQuery ($dql)
- ->setParameter ('KEY', $key)
- ->setParameter ('PARENTENDPOINTID', $parentEndpointID)
- ->getOneOrNullResult ();
+ ->createQuery($dql)
+ ->setParameter('KEY', $key)
+ ->setParameter('PARENTENDPOINTID', $parentEndpointID)
+ ->getOneOrNullResult();
return $property;
}
/**
- * This method will check that a user has edit permissions over a service before allowing a user to add, edit or delete
+ * This method will check that a user has edit permissions over a service before
+ * allowing a user to add, edit or delete
* any service information.
*
* @param \User $user
* @param \Service $service
* @throws \Exception
*/
- public function validateAddEditDeleteActions(\User $user, \Service $service) {
+ public function validateAddEditDeleteActions(\User $user, \Service $service)
+ {
// Check to see whether the user has a role that covers this service
// if(count($this->authorize Action(\Action::EDIT_OBJECT, $service, $user))==0){
// throw new \Exception("You don't have permission over ". $service->getHostName());
// }
- if ($this->roleActionAuthorisationService->authoriseAction ( \Action::EDIT_OBJECT, $service->getParentSite (), $user )->getGrantAction () == FALSE) {
- throw new \Exception ( "You don't have permission over service." );
+
+ if (
+ $this->roleAAS->authoriseAction(
+ \Action::EDIT_OBJECT,
+ $service->getParentSite(),
+ $user
+ )->getGrantAction() == false
+ ) {
+ throw new \Exception("You don't have permission over service.");
}
}
@@ -1050,22 +1238,23 @@ public function validateAddEditDeleteActions(\User $user, \Service $service) {
* @param bool $preventOverwrite
* @throws \Exception
*/
- public function addProperties(\Service $service, \User $user, array $propArr, $preventOverwrite = false) {
+ public function addProperties(\Service $service, \User $user, array $propArr, $preventOverwrite = false)
+ {
// Check the portal is not in read only mode, throws exception if it is
$this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
//Check that the user has the requisite permissions
- $this->validateAddEditDeleteActions ($user,$service);
+ $this->validateAddEditDeleteActions($user, $service);
//Make the change
- $this->em->getConnection ()->beginTransaction ();
+ $this->em->getConnection()->beginTransaction();
try {
- $this->addPropertiesLogic($service,$propArr,$preventOverwrite);
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $e ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
+ $this->addPropertiesLogic($service, $propArr, $preventOverwrite);
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
throw $e;
}
}
@@ -1075,22 +1264,30 @@ public function addProperties(\Service $service, \User $user, array $propArr, $p
* @param \Service $service
* @param array $propArr
* @param bool $preventOverwrite
- * @param string $authenticationType
- * @param string $authenticationIdentifier
+ * @param string $authType
+ * @param string $authIdentifier
* @throws \Exception
*/
- public function addServicePropertiesAPI(\Service $service, array $propKVArr, $preventOverwrite, $authenticationType, $authenticationIdentifier) {
+
+ public function addServicePropertiesAPI(
+ \Service $service,
+ array $propKVArr,
+ $preventOverwrite,
+ $authType,
+ $authIdentifier
+ ) {
//Check the portal is not in read only mode, throws exception if it is
$this->checkGOCDBIsNotReadOnly();
// Validate the user has permission to add properties
- $this->checkAuthorisedAPIIdentifier($service->getParentSite(), $authenticationIdentifier, $authenticationType);
+ $this->checkAuthorisedAPIIdentifier($service->getParentSite(), $authIdentifier, $authType);
//Convert the property array into the format used by the webportal logic
- #TODO: make the web portal use a more sensible format (e.g. array(key=> value), rather than array([1]=>key,array[2]=>value))
- $propArr=array();
+ #TODO: make the web portal use a more sensible format
+ #(e.g. array(key=> value), rather than array([1]=>key,array[2]=>value))
+ $propArr = array();
foreach ($propKVArr as $key => $value) {
- $propArr[]= array(0=>$key,1=>$value);
+ $propArr[] = array(0 => $key,1 => $value);
}
//Add the properties
@@ -1114,16 +1311,18 @@ public function addServicePropertiesAPI(\Service $service, array $propKVArr, $pr
* @param bool $preventOverwrite
* @throws \Exception
*/
- protected function addPropertiesLogic(\Service $service, array $propArr, $preventOverwrite = false) {
- $existingProperties = $service->getServiceProperties ();
+ protected function addPropertiesLogic(\Service $service, array $propArr, $preventOverwrite = false)
+ {
+ $existingProperties = $service->getServiceProperties();
//We will use this variable to track the keys as we go along, this will be used check they are all unique later
- $keys=array();
+ $keys = array();
- //We will use this variable to track teh final number of properties and ensure we do not exceede the specified limit
+ // We will use this variable to track teh final number of properties and
+ // ensure we do not exceede the specified limit
$propertyCount = sizeof($existingProperties);
- foreach ( $propArr as $i => $prop ) {
+ foreach ($propArr as $prop) {
/*Trim off trailing and leading whitspace - as we currently don't want this.
*The input array is awkwardly formatted as keys didn't use to have to be unique.
*/
@@ -1136,9 +1335,9 @@ protected function addPropertiesLogic(\Service $service, array $propArr, $preven
*we will want to edit the existing property later, rather than create it.
*/
$property = null;
- foreach ( $existingProperties as $existProp ) {
- if ($existProp->getKeyName () == $key) {
- $property=$existProp;
+ foreach ($existingProperties as $existProp) {
+ if ($existProp->getKeyName() == $key) {
+ $property = $existProp;
}
}
@@ -1148,39 +1347,48 @@ protected function addPropertiesLogic(\Service $service, array $propArr, $preven
*/
if (is_null($property)) {
// validate key value
+ $validateArray = [];
$validateArray ['NAME'] = $key;
$validateArray ['VALUE'] = $value;
- $this->validate ( $validateArray, 'serviceproperty' );
+ $this->validate($validateArray, 'serviceproperty');
- $serviceProperty = new \ServiceProperty ();
- $serviceProperty->setKeyName ( $key );
- $serviceProperty->setKeyValue ( $value );
- $service->addServicePropertyDoJoin ( $serviceProperty );
- $this->em->persist ( $serviceProperty );
+ $serviceProperty = new \ServiceProperty();
+ $serviceProperty->setKeyName($key);
+ $serviceProperty->setKeyValue($value);
+ $service->addServicePropertyDoJoin($serviceProperty);
+ $this->em->persist($serviceProperty);
//increment the property counter to enable check against property limit
$propertyCount++;
} elseif (!$preventOverwrite) {
- $this->editServicePropertyLogic($service, $property, array('SERVICEPROPERTIES'=>array('NAME'=>$key,'VALUE'=>$value)));
+ $this->editServicePropertyLogic(
+ $service,
+ $property,
+ array('SERVICEPROPERTIES' => array('NAME' => $key,'VALUE' => $value))
+ );
} else {
- throw new \Exception("A property with name \"$key\" already exists for this object, no properties were added.");
+ throw new \Exception(
+ "A property with name \"$key\" already exists for this object, no properties were added."
+ );
}
- //Add the key to the keys array, to enable unique check
- $keys[]=$key;
+ // Add the key to the keys array, to enable unique check
+ $keys[] = $key;
}
- //Keys should be unique, create an exception if they are not
- if(count(array_unique($keys))!=count($keys)) {
+ // Keys should be unique, create an exception if they are not
+ if (count(array_unique($keys)) != count($keys)) {
throw new \Exception(
- "Property names should be unique. The requested new properties include multiple properties with the same name."
+ "Property names should be unique. The requested new properties " .
+ "include multiple properties with the same name."
);
}
- //Check to see if adding the new properties will exceed the max limit defined in local_info.xml, and throw an exception if so
+ // Check to see if adding the new properties will exceed the max limit
+ // defined in local_info.xml, and throw an exception if so
$extensionLimit = \Factory::getConfigService()->getExtensionsLimit();
- if ($propertyCount > $extensionLimit){
+ if ($propertyCount > $extensionLimit) {
throw new \Exception("Property(s) could not be added due to the property limit of $extensionLimit");
}
}
@@ -1194,22 +1402,29 @@ protected function addPropertiesLogic(\Service $service, array $propArr, $preven
* @param bool $preventOverwrite
* @throws \Exception
*/
- public function addEndpointProperties(\EndpointLocation $endpoint, \User $user, array $propArr, $preventOverwrite = false) {
+
+ public function addEndpointProperties(
+ \EndpointLocation $endpoint,
+ \User $user,
+ array $propArr,
+ $preventOverwrite = false
+ ) {
+
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ($user);
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
//Check the user has the requisite permissions
- $this->validateAddEditDeleteActions ($user, $endpoint->getService());
+ $this->validateAddEditDeleteActions($user, $endpoint->getService());
//Make the change
- $this->em->getConnection ()->beginTransaction ();
+ $this->em->getConnection()->beginTransaction();
try {
- $this->addEndpointPropertiesLogic($endpoint,$propArr,$preventOverwrite);
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $e ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
+ $this->addEndpointPropertiesLogic($endpoint, $propArr, $preventOverwrite);
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
throw $e;
}
}
@@ -1219,22 +1434,37 @@ public function addEndpointProperties(\EndpointLocation $endpoint, \User $user,
* @param \EndpointLocation $service
* @param array $propArr
* @param bool $preventOverwrite
- * @param string $authenticationType
- * @param string $authenticationIdentifier
+ * @param string $authType
+ * @param string $authIdentifier
* @throws \Exception
*/
- public function addEndpointPropertiesAPI(\EndpointLocation $endpoint, array $propKVArr, $preventOverwrite, $authenticationType, $authenticationIdentifier) {
+
+ public function addEndpointPropertiesAPI(
+ \EndpointLocation $endpoint,
+ array $propKVArr,
+ $preventOverwrite,
+ $authType,
+ $authIdentifier
+ ) {
+
//Check the portal is not in read only mode, throws exception if it is
$this->checkGOCDBIsNotReadOnly();
// Validate the user has permission to add properties
- $this->checkAuthorisedAPIIdentifier($endpoint->getService()->getParentSite(), $authenticationIdentifier, $authenticationType);
+
+ $this->checkAuthorisedAPIIdentifier(
+ $endpoint->getService()->getParentSite(),
+ $authIdentifier,
+ $authType
+ );
+
//Convert the property array into the format used by the webportal logic
- #TODO: make the web portal use a more sensible format (e.g. array(key=> value), rather than array([1]=>key,array[2]=>value))
- $propArr=array();
+ # TODO: make the web portal use a more sensible format
+ # (e.g. array(key=> value), rather than array([1]=>key,array[2]=>value))
+ $propArr = array();
foreach ($propKVArr as $key => $value) {
- $propArr[]= array(0=>$key,1=>$value);
+ $propArr[] = array(0 => $key,1 => $value);
}
//Add the properties
@@ -1258,16 +1488,24 @@ public function addEndpointPropertiesAPI(\EndpointLocation $endpoint, array $pro
* @param bool $preventOverwrite
* @throws \Exception
*/
- protected function addEndpointPropertiesLogic(\EndpointLocation $endpoint, array $propArr, $preventOverwrite = false) {
- $existingProperties = $endpoint->getEndpointProperties ();
- //We will use this variable to track the keys as we go along, this will be used check they are all unique later
- $keys=array();
+ protected function addEndpointPropertiesLogic(
+ \EndpointLocation $endpoint,
+ array $propArr,
+ $preventOverwrite = false
+ ) {
+
+ $existingProperties = $endpoint->getEndpointProperties();
- //We will use this variable to track teh final number of properties and ensure we do not exceede the specified limit
+ // We will use this variable to track the keys as we go along,
+ // this will be used check they are all unique later
+ $keys = array();
+
+ // We will use this variable to track the final number of properties
+ // and ensure we do not exceede the specified limit
$propertyCount = sizeof($existingProperties);
- foreach ( $propArr as $i => $prop ) {
+ foreach ($propArr as $prop) {
/*Trim off trailing and leading whitspace - as we currently don't want this.
*The input array is awkwardly formatted as keys didn't use to have to be unique.
*/
@@ -1280,8 +1518,8 @@ protected function addEndpointPropertiesLogic(\EndpointLocation $endpoint, array
*we will want to edit the existing property later, rather than create it.
*/
$property = null;
- foreach ( $existingProperties as $existProp ) {
- if ($existProp->getKeyName () == $key) {
+ foreach ($existingProperties as $existProp) {
+ if ($existProp->getKeyName() == $key) {
$property = $existProp;
}
}
@@ -1292,40 +1530,48 @@ protected function addEndpointPropertiesLogic(\EndpointLocation $endpoint, array
*/
if (is_null($property)) {
// validate key value
+ $validateArray = [];
$validateArray ['NAME'] = $key;
$validateArray ['VALUE'] = $value;
- $validateArray ['ENDPOINTID'] = $endpoint->getId ();
- $this->validate ( $validateArray, 'endpointproperty' );
+ $validateArray ['ENDPOINTID'] = $endpoint->getId();
+ $this->validate($validateArray, 'endpointproperty');
- $property = new \EndpointProperty ();
- $property->setKeyName ( $key );
- $property->setKeyValue ( $value );
- $endpoint->addEndpointPropertyDoJoin ( $property );
- $this->em->persist ( $property );
+ $property = new \EndpointProperty();
+ $property->setKeyName($key);
+ $property->setKeyValue($value);
+ $endpoint->addEndpointPropertyDoJoin($property);
+ $this->em->persist($property);
//increment the property counter to enable check against property limit
$propertyCount++;
} elseif (!$preventOverwrite) {
- $this->editEndpointPropertyLogic($endpoint->getService(), $property, array('ENDPOINTPROPERTIES'=>array('NAME'=>$key,'VALUE'=>$value)));
+ $this->editEndpointPropertyLogic(
+ $endpoint->getService(),
+ $property,
+ array('ENDPOINTPROPERTIES' => array('NAME' => $key,'VALUE' => $value))
+ );
} else {
- throw new \Exception("A property with name \"$key\" already exists for this object, no properties were added.");
+ throw new \Exception("A property with name \"$key\" already exists for " .
+ "this object, no properties were added.");
}
//Add the key to the keys array, to enable unique check
- $keys[]=$key;
+ $keys[] = $key;
}
- //Keys should be unique, create an exception if they are not
- if(count(array_unique($keys))!=count($keys)) {
+ // Keys should be unique, create an exception if they are not
+ if (count(array_unique($keys)) != count($keys)) {
throw new \Exception(
- "Property names should be unique. The requested new properties include multiple properties with the same name."
+ "Property names should be unique. " .
+ "The requested new properties include multiple properties with the same name."
);
}
- //Check to see if adding the new properties will exceed the max limit defined in local_info.xml, and throw an exception if so
+ // Check to see if adding the new properties will exceed the max limit
+ // defined in local_info.xml, and throw an exception if so
$extensionLimit = \Factory::getConfigService()->getExtensionsLimit();
- if ($propertyCount > $extensionLimit){
+ if ($propertyCount > $extensionLimit) {
throw new \Exception("Property(s) could not be added due to the property limit of $extensionLimit");
}
}
@@ -1339,22 +1585,23 @@ protected function addEndpointPropertiesLogic(\EndpointLocation $endpoint, array
* @param \User $user
* @param array $propArr
*/
- public function deleteServiceProperties(\Service $service, \User $user, array $propArr) {
+ public function deleteServiceProperties(\Service $service, \User $user, array $propArr)
+ {
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ( $user );
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
//Ensure the user has the requisite permissions
- $this->validateAddEditDeleteActions ( $user, $service );
+ $this->validateAddEditDeleteActions($user, $service);
//Make the change
- $this->em->getConnection ()->beginTransaction ();
+ $this->em->getConnection()->beginTransaction();
try {
$this->deleteServicePropertiesLogic($service, $propArr);
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $e ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
throw $e;
}
}
@@ -1366,7 +1613,8 @@ public function deleteServiceProperties(\Service $service, \User $user, array $p
* @param \User $user
* @param array $propArr
*/
- public function deleteServicePropertiesAPI(\Service $service, array $propArr, $authIdentifierType, $authIdentifier) {
+ public function deleteServicePropertiesAPI(\Service $service, array $propArr, $authIdentifierType, $authIdentifier)
+ {
//Check the portal is not in read only mode, throws exception if it is
$this->checkGOCDBIsNotReadOnly();
@@ -1397,19 +1645,20 @@ public function deleteServicePropertiesAPI(\Service $service, array $propArr, $a
* @param \Service $service
* @param array $propArr
*/
- protected function deleteServicePropertiesLogic(\Service $service, array $propArr) {
- foreach ( $propArr as $prop ) {
+ protected function deleteServicePropertiesLogic(\Service $service, array $propArr)
+ {
+ foreach ($propArr as $prop) {
// throw new \Exception(var_dump($prop));
// check property is in service
- if ($prop->getParentService () != $service) {
- $id = $prop->getId ();
- throw new \Exception ( "Property {$id} does not belong to the specified service" );
+ if ($prop->getParentService() != $service) {
+ $id = $prop->getId();
+ throw new \Exception("Property {$id} does not belong to the specified service");
}
// Service is the owning side so remove elements from service.
- $service->getServiceProperties ()->removeElement ( $prop );
+ $service->getServiceProperties()->removeElement($prop);
// Once relationship is removed delete the actual element
- $this->em->remove ( $prop );
+ $this->em->remove($prop);
}
}
@@ -1421,22 +1670,23 @@ protected function deleteServicePropertiesLogic(\Service $service, array $propAr
* @param \User $user
* @param array $propArr
*/
- public function deleteEndpointProperties(\Service $service, \User $user, array $propArr) {
+ public function deleteEndpointProperties(\Service $service, \User $user, array $propArr)
+ {
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ( $user );
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
//Check the user has the rquisite permissions
- $this->validateAddEditDeleteActions ($user, $service);
+ $this->validateAddEditDeleteActions($user, $service);
// Carry out the change
- $this->em->getConnection ()->beginTransaction ();
+ $this->em->getConnection()->beginTransaction();
try {
$this->deleteEndpointPropertiesLogic($service, $propArr);
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $e ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
throw $e;
}
}
@@ -1448,8 +1698,14 @@ public function deleteEndpointProperties(\Service $service, \User $user, array $
* @param \User $user
* @param array $propArr
*/
- public function deleteEndpointPropertiesAPI(\EndpointLocation $endpoint, array $propArr, $authIdentifierType, $authIdentifier) {
- //Check the portal is not in read only mode, throws exception if it is
+
+ public function deleteEndpointPropertiesAPI(
+ \EndpointLocation $endpoint,
+ array $propArr,
+ $authIdentifierType,
+ $authIdentifier
+ ) {
+ // Check the portal is not in read only mode, throws exception if it is
$this->checkGOCDBIsNotReadOnly();
$parentService = $endpoint->getService();
@@ -1484,27 +1740,27 @@ public function deleteEndpointPropertiesAPI(\EndpointLocation $endpoint, array $
* @param \Service $service
* @param array $propArr
*/
- protected function deleteEndpointPropertiesLogic(\Service $service, array $propArr) {
- foreach ( $propArr as $prop ) {
-
+ protected function deleteEndpointPropertiesLogic(\Service $service, array $propArr)
+ {
+ foreach ($propArr as $prop) {
// check endpoint property has a parent endpoint
- $endpoint = $prop->getParentEndpoint ();
+ $endpoint = $prop->getParentEndpoint();
if ($endpoint == null) {
- $id = $prop->getId ();
- throw new \Exception ( "Property {$id} does not have a parent endpoint" );
+ $id = $prop->getId();
+ throw new \Exception("Property {$id} does not have a parent endpoint");
}
if ($endpoint->getService() != $service) {
- $id = $prop->getId ();
- throw new \Exception (
+ $id = $prop->getId();
+ throw new \Exception(
"Property {$id} does not belong to an endpoint of the specified service"
);
}
// Endoint is the owning side so remove elements from endpoint.
- $endpoint->getEndpointProperties ()->removeElement ( $prop );
+ $endpoint->getEndpointProperties()->removeElement($prop);
// Once relationship is removed delete the actual element
- $this->em->remove ( $prop );
+ $this->em->remove($prop);
}
}
@@ -1519,22 +1775,23 @@ protected function deleteEndpointPropertiesLogic(\Service $service, array $propA
* @param \ServiceProperty $prop
* @param array $newValues
*/
- public function editServiceProperty(\Service $service, \User $user, \ServiceProperty $prop, $newValues) {
+ public function editServiceProperty(\Service $service, \User $user, \ServiceProperty $prop, $newValues)
+ {
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ( $user );
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
// Validate the user has permission to edit properties
- $this->validateAddEditDeleteActions ( $user, $service );
+ $this->validateAddEditDeleteActions($user, $service);
//Make the change
- $this->em->getConnection ()->beginTransaction ();
+ $this->em->getConnection()->beginTransaction();
try {
$this->editServicePropertyLogic($service, $prop, $newValues);
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $ex ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $ex) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
throw $ex;
}
}
@@ -1549,22 +1806,23 @@ public function editServiceProperty(\Service $service, \User $user, \ServiceProp
* @param \ServiceProperty $prop
* @param array $newValues
*/
- protected function editServicePropertyLogic(\Service $service, \ServiceProperty $prop, $newValues) {
+ protected function editServicePropertyLogic(\Service $service, \ServiceProperty $prop, $newValues)
+ {
- $this->validate ( $newValues ['SERVICEPROPERTIES'], 'serviceproperty' );
+ $this->validate($newValues ['SERVICEPROPERTIES'], 'serviceproperty');
//We don't currently want trailing or leading whitespace, so we trim it
$keyname = trim($newValues['SERVICEPROPERTIES']['NAME']);
$keyvalue = trim($newValues['SERVICEPROPERTIES']['VALUE']);
// Check that the prop is from the service
- if ($prop->getParentService () != $service) {
- $id = $prop->getId ();
- throw new \Exception ( "Property {$id} does not belong to the specified service" );
+ if ($prop->getParentService() != $service) {
+ $id = $prop->getId();
+ throw new \Exception("Property {$id} does not belong to the specified service");
}
//If the properties key has changed, check there isn't an existing property with that key
- if ($keyname != $prop->getKeyName()){
+ if ($keyname != $prop->getKeyName()) {
$existingProperties = $service->getServiceProperties();
foreach ($existingProperties as $existingProp) {
if ($existingProp->getKeyName() == $keyname) {
@@ -1574,10 +1832,10 @@ protected function editServicePropertyLogic(\Service $service, \ServiceProperty
}
// Set the service propertys new member variables
- $prop->setKeyName ( $keyname );
- $prop->setKeyValue ( $keyvalue );
+ $prop->setKeyName($keyname);
+ $prop->setKeyValue($keyvalue);
- $this->em->merge ( $prop );
+ $this->em->merge($prop);
}
/**
@@ -1592,22 +1850,23 @@ protected function editServicePropertyLogic(\Service $service, \ServiceProperty
* @param array $newValues
* @throws \Exception
*/
- public function editEndpointProperty(\Service $service, \User $user, \EndpointProperty $prop, $newValues) {
+ public function editEndpointProperty(\Service $service, \User $user, \EndpointProperty $prop, $newValues)
+ {
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ($user);
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
// Validate the user has permission to edit properties
- $this->validateAddEditDeleteActions ($user, $service);
+ $this->validateAddEditDeleteActions($user, $service);
//Make the change
- $this->em->getConnection ()->beginTransaction ();
+ $this->em->getConnection()->beginTransaction();
try {
$this->editEndpointPropertyLogic($service, $prop, $newValues);
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $ex ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $ex) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
throw $ex;
}
}
@@ -1623,22 +1882,23 @@ public function editEndpointProperty(\Service $service, \User $user, \EndpointPr
* @param array $newValues
* @throws \Exception
*/
- protected function editEndpointPropertyLogic(\Service $service, \EndpointProperty $prop, $newValues) {
+ protected function editEndpointPropertyLogic(\Service $service, \EndpointProperty $prop, $newValues)
+ {
- $this->validate ( $newValues ['ENDPOINTPROPERTIES'], 'endpointproperty' );
+ $this->validate($newValues ['ENDPOINTPROPERTIES'], 'endpointproperty');
//We don't currently want trailing or leading whitespace, so we trim it
$keyname = trim($newValues['ENDPOINTPROPERTIES']['NAME']);
$keyvalue = trim($newValues['ENDPOINTPROPERTIES']['VALUE']);
// Check that the prop is from the endpoint
- if ($prop->getParentEndpoint ()->getService () != $service) {
- $id = $prop->getId ();
- throw new \Exception ( "Property {$id} does not belong to the specified service endpoint" );
+ if ($prop->getParentEndpoint()->getService() != $service) {
+ $id = $prop->getId();
+ throw new \Exception("Property {$id} does not belong to the specified service endpoint");
}
//If the properties key has changed, check there isn't an existing property with that key
- if ($keyname != $prop->getKeyName()){
+ if ($keyname != $prop->getKeyName()) {
$existingProperties = $prop->getParentEndpoint()->getEndpointProperties();
foreach ($existingProperties as $existingProp) {
if ($existingProp->getKeyName() == $keyname) {
@@ -1648,51 +1908,60 @@ protected function editEndpointPropertyLogic(\Service $service, \EndpointPropert
}
// Set the endpoints propertys new member variables
- $prop->setKeyName ( $keyname );
- $prop->setKeyValue ( $keyvalue );
+ $prop->setKeyName($keyname);
+ $prop->setKeyValue($keyvalue);
- $this->em->merge ( $prop );
+ $this->em->merge($prop);
}
/**
* Deletes a service
*
- * @param \Service $s To be deleted
+ * @param \Service $service To be deleted
* @param \User $user Making the request
* @param $isTest when unit testing this allows for true to be supplied and this method
* will not attempt to archive the service which can easily cause errors for service objects without
* a full set of information
* @throws \Exception If user can't be authorized
*/
- public function deleteService(\Service $s, \User $user = null, $isTest = false) {
+ public function deleteService(\Service $service, \User $user = null, $isTest = false)
+ {
require_once __DIR__ . '/../DAOs/ServiceDAO.php';
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ( $user );
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
- if ($this->roleActionAuthorisationService->authoriseAction ( \Action::EDIT_OBJECT, $s->getParentSite (), $user )->getGrantAction () == FALSE) {
- throw new \Exception ( "You don't have permission to delete service." );
+
+ if (
+ $this->roleAAS->authoriseAction(
+ \Action::EDIT_OBJECT,
+ $service->getParentSite(),
+ $user
+ )->getGrantAction() == false
+ ) {
+ throw new \Exception("You don't have permission to delete service.");
}
- $this->em->getConnection ()->beginTransaction ();
+
+ $this->em->getConnection()->beginTransaction();
try {
- $serviceDAO = new \ServiceDAO ();
- $serviceDAO->setEntityManager ( $this->em );
+ $serviceDAO = new \ServiceDAO();
+ $serviceDAO->setEntityManager($this->em);
// Archive site - if this is a test then don't archive
if ($isTest == false) {
// Create entry in audit table
- $serviceDAO->addServiceToArchive ( $s, $user );
+ $serviceDAO->addServiceToArchive($service, $user);
}
// Break links with downtimes and remove downtimes only associated
// with this service, then remove service
- $serviceDAO->removeService ( $s );
+ $serviceDAO->removeService($service);
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $e ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
throw $e;
}
}
@@ -1702,53 +1971,52 @@ public function deleteService(\Service $s, \User $user = null, $isTest = false)
*
* If the service is already a child of the site, no move is attempted.
*
- * @param \Service $Service Service to move.
- * @param \Site $Site Target site to move the service to.
+ * @param \Service $service Service to move.
+ * @param \Site $site Target site to move the service to.
* @param \User $user
* @throws \Exception
* @throws \LogicException
*/
- public function moveService(\Service $Service, \Site $Site, \User $user = null) {
+ public function moveService(\Service $service, \Site $site, \User $user = null)
+ {
// Throws exception if user is not an administrator
- $this->checkUserIsAdmin ( $user );
+ $this->checkUserIsAdmin($user);
- $this->em->getConnection ()->beginTransaction (); // suspend auto-commit
+ $this->em->getConnection()->beginTransaction(); // suspend auto-commit
try {
// If the site or service have no ID - throw logic exception
- $site_id = $Site->getId ();
- if (empty ( $site_id )) {
- throw new \LogicException ( 'Site has no ID' );
+ $siteId = $site->getId();
+ if (empty($siteId)) {
+ throw new \LogicException('Site has no ID');
}
- $Service_id = $Service->getId ();
- if (empty ( $Service_id )) {
- throw new \LogicException ( 'Service has no ID' );
+ $serviceId = $service->getId();
+ if (empty($serviceId)) {
+ throw new \LogicException('Service has no ID');
}
// find old site
- $old_Site = $Service->getParentSite ();
+ $oldSite = $service->getParentSite();
// If the Site has changed, then we move the service.
- if ($old_Site != $Site) {
-
+ if ($oldSite != $site) {
// Remove the service from the old site if it has an old site
- if (! empty ( $old_Site )) {
-
- $old_Site->getServices ()->removeElement ( $Service );
+ if (! empty($oldSite)) {
+ $oldSite->getServices()->removeElement($service);
}
// Add Service to new Site
- $Site->addServiceDoJoin ( $Service );
+ $site->addServiceDoJoin($service);
// persist
- $this->em->merge ( $Site );
- $this->em->merge ( $old_Site );
+ $this->em->merge($site);
+ $this->em->merge($oldSite);
} // close if
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $e ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
throw $e;
}
}
@@ -1758,59 +2026,48 @@ public function moveService(\Service $Service, \Site $Site, \User $user = null)
*
* @returns boolean
*/
- public function servicePropSet (\Service $service, $servicePropName) {
- switch (strtolower($servicePropName)) {
- case 'hostname':{
- $propValue = $service->getHostName();
- break;
- }
- case 'description':{
- $propValue = $service->getDescription();
- break;
- }
- case 'url':{
- $propValue = $service->getUrl();
- break;
- }
- case 'host_dn':{
- $propValue = $service->getDn();
- break;
- }
- case 'host_ip':{
- $propValue = $service->getIpAddress();
- break;
- }
- case 'host_ip_v6':{
- $propValue = $service->getIpV6Address();
- break;
- }
- case 'host_os':{
- $propValue = $service->getOperatingSystem();
- break;
- }
- case 'email':{
- $propValue = $service->getEmail();
- break;
- }
- case 'host_arch':{
- $propValue = $service->getArchitecture();
- break;
- }
- case 'monitored':
- case 'beta':
- case 'production':
- case 'notify':
- {
- #booleans are always set
- return true;
- }
- default:{
- throw new \Exception("Internal error: service property name ($servicePropName) not ".
- "recognised. Please contact a GOCDB administrator and report this error.");
- }
- }
-
- return !empty($propValue);
+ public function servicePropSet(\Service $service, $servicePropName)
+ {
+ switch (strtolower($servicePropName)) {
+ case 'hostname':
+ $propValue = $service->getHostName();
+ break;
+ case 'description':
+ $propValue = $service->getDescription();
+ break;
+ case 'url':
+ $propValue = $service->getUrl();
+ break;
+ case 'host_dn':
+ $propValue = $service->getDn();
+ break;
+ case 'host_ip':
+ $propValue = $service->getIpAddress();
+ break;
+ case 'host_ip_v6':
+ $propValue = $service->getIpV6Address();
+ break;
+ case 'host_os':
+ $propValue = $service->getOperatingSystem();
+ break;
+ case 'email':
+ $propValue = $service->getEmail();
+ break;
+ case 'host_arch':
+ $propValue = $service->getArchitecture();
+ break;
+ case 'monitored':
+ case 'beta':
+ case 'production':
+ case 'notify':
+ #booleans are always set
+ return true;
+ default:
+ throw new \Exception("Internal error: service property name ($servicePropName) not " .
+ "recognised. Please contact a GOCDB administrator and report this error.");
+ }
+
+ return !empty($propValue);
}
/**
@@ -1821,16 +2078,17 @@ public function servicePropSet (\Service $service, $servicePropName) {
* @throws Exception
* @return \Endpoint
*/
- public function addEndpoint($values, \User $user = null) {
+ public function addEndpoint($values, \User $user = null)
+ {
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ( $user );
- $this->validate ( $values ['SERVICEENDPOINT'], 'endpoint' );
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
+ $this->validate($values ['SERVICEENDPOINT'], 'endpoint');
$serviceID = $values ['SERVICEENDPOINT'] ['SERVICE'];
- $service = $this->getService ( $serviceID );
+ $service = $this->getService($serviceID);
// check user has permission to edit endpoint's service
- $this->validateAddEditDeleteActions ( $user, $service );
+ $this->validateAddEditDeleteActions($user, $service);
$name = $values ['SERVICEENDPOINT'] ['NAME'];
$url = $values ['SERVICEENDPOINT'] ['URL'];
@@ -1841,10 +2099,10 @@ public function addEndpoint($values, \User $user = null) {
if ($values ['SERVICEENDPOINT'] ['INTERFACENAME'] != '') {
$interfaceName = $values ['SERVICEENDPOINT'] ['INTERFACENAME'];
} else {
- $interfaceName = ( string ) $service->getServiceType ();
+ $interfaceName = (string) $service->getServiceType();
}
- if($values['IS_MONITORED']) {
+ if ($values['IS_MONITORED']) {
$monitored = true;
} else {
$monitored = false;
@@ -1867,13 +2125,24 @@ public function addEndpoint($values, \User $user = null) {
* @param string $authIdentifier Authentication string from API
* @param string $authIdentifierType Type of Authentication string
*/
- public function addEndpointApi(\Service $service, $name, $url, $interfaceName, $description, $email, $monitored, $authIdentifier, $authIdentifierType) {
- //Check the portal is not in read only mode, throws exception if it is
- $this->checkGOCDBIsNotReadOnly();
- $this->checkAuthorisedAPIIdentifier($service->getParentSite(), $authIdentifier, $authIdentifierType);
+ public function addEndpointApi(
+ \Service $service,
+ $name,
+ $url,
+ $interfaceName,
+ $description,
+ $email,
+ $monitored,
+ $authIdentifier,
+ $authIdentifierType
+ ) {
+ // Check the portal is not in read only mode, throws exception if it is
+ $this->checkGOCDBIsNotReadOnly();
+
+ $this->checkAuthorisedAPIIdentifier($service->getParentSite(), $authIdentifier, $authIdentifierType);
- $this->addEndpointLogic($service, $name, $url, $interfaceName, $description, $email, $monitored);
+ $this->addEndpointLogic($service, $name, $url, $interfaceName, $description, $email, $monitored);
}
/**
@@ -1889,36 +2158,37 @@ public function addEndpointApi(\Service $service, $name, $url, $interfaceName, $
* @param boolean $monitored whether endpoint is monitored
* @throws \Exception
*/
- private function addEndpointLogic (\Service $service, $name, $url, $interfaceName, $description, $email, $monitored){
+ private function addEndpointLogic(\Service $service, $name, $url, $interfaceName, $description, $email, $monitored)
+ {
- if (empty ( $name )) {
- throw new \Exception ( "An endpoint must have a name." );
- }
+ if (empty($name)) {
+ throw new \Exception("An endpoint must have a name.");
+ }
// check endpoint's name is unique under the service
- if($this->endpointWithNameExists($service, $name)){
- throw new \Exception ( "Please provide a unique name for this Service Endpoint." );
- }
-
- $this->em->getConnection ()->beginTransaction ();
- try {
- $endpoint = new \EndpointLocation ();
- $endpoint->setName($name);
- $endpoint->setUrl($url);
- $endpoint->setInterfaceName($interfaceName);
- $endpoint->setDescription($description);
- $endpoint->setEmail($email);
- $endpoint->setMonitored($monitored);
- $service->addEndpointLocationDoJoin($endpoint);
- $this->em->persist($endpoint);
-
- $this->em->flush();
- $this->em->getConnection()->commit();
- } catch(\Exception $e) {
- $this->em->getConnection()->rollback();
- $this->em->close();
- throw $e;
- }
- return $endpoint;
+ if ($this->endpointWithNameExists($service, $name)) {
+ throw new \Exception("Please provide a unique name for this Service Endpoint.");
+ }
+
+ $this->em->getConnection()->beginTransaction();
+ try {
+ $endpoint = new \EndpointLocation();
+ $endpoint->setName($name);
+ $endpoint->setUrl($url);
+ $endpoint->setInterfaceName($interfaceName);
+ $endpoint->setDescription($description);
+ $endpoint->setEmail($email);
+ $endpoint->setMonitored($monitored);
+ $service->addEndpointLocationDoJoin($endpoint);
+ $this->em->persist($endpoint);
+
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
+ throw $e;
+ }
+ return $endpoint;
}
/**
@@ -1931,17 +2201,19 @@ private function addEndpointLogic (\Service $service, $name, $url, $interfaceNam
* @throws \Exception
* @throws Exception
*/
- public function editEndpoint(\User $user, \EndpointLocation $endpoint, $newValues) {
+ public function editEndpoint(\User $user, \EndpointLocation $endpoint, $newValues)
+ {
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ( $user );
- $this->validate ( $newValues ['SERVICEENDPOINT'], 'endpoint' );
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
+ $this->validate($newValues ['SERVICEENDPOINT'], 'endpoint');
- //We shouldn't rely on the service being given to the function - this allows bugs to be introduced that feed the wrong service
- //TODO: remove the $service from the endpoint parameters
- $service = $endpoint->getService ();
+ // We shouldn't rely on the service being given to the function - this
+ // allows bugs to be introduced that feed the wrong service
+ // TODO: remove the $service from the endpoint parameters
+ $service = $endpoint->getService();
// check user has permission to edit endpoint's service
- $this->validateAddEditDeleteActions ( $user, $service );
+ $this->validateAddEditDeleteActions($user, $service);
$name = $newValues ['SERVICEENDPOINT'] ['NAME'];
$url = $newValues ['SERVICEENDPOINT'] ['URL'];
@@ -1949,7 +2221,7 @@ public function editEndpoint(\User $user, \EndpointLocation $endpoint, $newValue
$email = $newValues['SERVICEENDPOINT']['EMAIL'];
$interfaceName = $newValues ['SERVICEENDPOINT'] ['INTERFACENAME'];
- if($newValues['IS_MONITORED']) {
+ if ($newValues['IS_MONITORED']) {
$monitored = true;
} else {
$monitored = false;
@@ -1971,14 +2243,30 @@ public function editEndpoint(\User $user, \EndpointLocation $endpoint, $newValue
* @param string $authIdentifier Authentication string from API
* @param string $authIdentifierType Type of Authentication string
*/
- public function editEndpointApi (\EndpointLocation $endpoint, $name, $url, $interfaceName, $description, $email, $monitored, $authIdentifier, $authIdentifierType) {
- //Check the portal is not in read only mode, throws exception if it is
- $this->checkGOCDBIsNotReadOnly();
- $this->checkAuthorisedAPIIdentifier($endpoint->getService()->getParentSite(), $authIdentifier, $authIdentifierType);
+ public function editEndpointApi(
+ \EndpointLocation $endpoint,
+ $name,
+ $url,
+ $interfaceName,
+ $description,
+ $email,
+ $monitored,
+ $authIdentifier,
+ $authIdentifierType
+ ) {
+ // Check the portal is not in read only mode, throws exception if it is
+ $this->checkGOCDBIsNotReadOnly();
+
+
+ $this->checkAuthorisedAPIIdentifier(
+ $endpoint->getService()->getParentSite(),
+ $authIdentifier,
+ $authIdentifierType
+ );
- $this->editEndpointLogic($endpoint, $name, $url, $interfaceName, $description, $email, $monitored);
+ $this->editEndpointLogic($endpoint, $name, $url, $interfaceName, $description, $email, $monitored);
}
/**
@@ -1993,44 +2281,54 @@ public function editEndpointApi (\EndpointLocation $endpoint, $name, $url, $inte
* @param boolean $monitored whether endpoint is monitored
* @throws \Exception
*/
- private function editEndpointLogic (\EndpointLocation $endpoint, $name, $url, $interfaceName, $description, $email, $monitored){
- $service = $endpoint->getService ();
- if (empty ( $name )) {
- throw new \Exception ( "An endpoint must have a name." );
- }
+ private function editEndpointLogic(
+ \EndpointLocation $endpoint,
+ $name,
+ $url,
+ $interfaceName,
+ $description,
+ $email,
+ $monitored
+ ) {
+
+ $service = $endpoint->getService();
+
+ if (empty($name)) {
+ throw new \Exception("An endpoint must have a name.");
+ }
//if no interface name is provided, default to service type
- if ($interfaceName == '') {
- $interfaceName = ( string ) $service->getServiceType ();
- }
+ if ($interfaceName == '') {
+ $interfaceName = (string) $service->getServiceType();
+ }
// check endpoint's name is unique under the service
- foreach ( $service->getEndpointLocations () as $endpointL ) {
- // exclude itself
- if ($endpoint != $endpointL && $endpointL->getName () == $name) {
- throw new \Exception ( "Please provide a unique name for this endpoint." );
- }
- }
-
- $this->em->getConnection ()->beginTransaction ();
-
- try {
- // Set the endpoints new member variables
- $endpoint->setName ( $name );
- $endpoint->setUrl ( $url );
- $endpoint->setInterfaceName ( $interfaceName );
- $endpoint->setDescription ( $description );
- $endpoint->setEmail($email);
- $endpoint->setMonitored($monitored);
- $this->em->merge ( $endpoint );
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $ex ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
- throw $ex;
- }
+ foreach ($service->getEndpointLocations() as $endpointL) {
+ // exclude itself
+ if ($endpoint != $endpointL && $endpointL->getName() == $name) {
+ throw new \Exception("Please provide a unique name for this endpoint.");
+ }
+ }
+
+ $this->em->getConnection()->beginTransaction();
+
+ try {
+ // Set the endpoints new member variables
+ $endpoint->setName($name);
+ $endpoint->setUrl($url);
+ $endpoint->setInterfaceName($interfaceName);
+ $endpoint->setDescription($description);
+ $endpoint->setEmail($email);
+ $endpoint->setMonitored($monitored);
+ $this->em->merge($endpoint);
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $ex) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
+ throw $ex;
+ }
}
/**
@@ -2040,15 +2338,16 @@ private function editEndpointLogic (\EndpointLocation $endpoint, $name, $url, $i
* @param \User $user
* @throws Exception
*/
- public function deleteEndpoint(\EndpointLocation $endpoint, \User $user) {
+ public function deleteEndpoint(\EndpointLocation $endpoint, \User $user)
+ {
// Check the portal is not in read only mode, throws exception if it is
- $this->checkPortalIsNotReadOnlyOrUserIsAdmin ( $user );
+ $this->checkPortalIsNotReadOnlyOrUserIsAdmin($user);
- $service = $endpoint->getService ();
+ $service = $endpoint->getService();
// check user has permission to edit endpoint's service
- $this->validateAddEditDeleteActions ( $user, $service );
+ $this->validateAddEditDeleteActions($user, $service);
$this->deleteEndpointLogic($endpoint);
}
@@ -2056,43 +2355,51 @@ public function deleteEndpoint(\EndpointLocation $endpoint, \User $user) {
/**
* Function called from API to delete an endpoint
*
- * @param EndpointLocation $endpoint endpoint to be deleted
- * @param Service $service service of endpoint being deleted
+ * @param \EndpointLocation $endpoint endpoint to be deleted
+ * @param \Service $service service of endpoint being deleted
* @thows Exception
*/
- public function deleteEndpointAPI (\EndpointLocation $endpoint, $authIdentifier, $authIdentifierType) {
- //Check the portal is not in read only mode, throws exception if it is
- $this->checkGOCDBIsNotReadOnly();
+ public function deleteEndpointAPI(\EndpointLocation $endpoint, $authIdentifier, $authIdentifierType)
+ {
+ // Check the portal is not in read only mode, throws exception if it is
+ $this->checkGOCDBIsNotReadOnly();
+
+ // Check authorisation
+
+ $this->checkAuthorisedAPIIdentifier(
+ $endpoint->getService()->getParentSite(),
+ $authIdentifier,
+ $authIdentifierType
+ );
- //Check authorisation
- $this->checkAuthorisedAPIIdentifier($endpoint->getService()->getParentSite(), $authIdentifier, $authIdentifierType);
- //Make the change
- $this->deleteEndpointLogic($endpoint);
+ // Make the change
+ $this->deleteEndpointLogic($endpoint);
}
/**
* Logic to delete an endpoint, abstracted array from authorisation and validation
*
- * @param EndpointLocation $endpoint endpoint to delete
- * @throws Exception
+ * @param \EndpointLocation $endpoint endpoint to delete
+ * @throws \Exception
*/
- private function deleteEndpointLogic (\EndpointLocation $endpoint) {
- require_once __DIR__ . '/../DAOs/ServiceDAO.php';
-
- $this->em->getConnection ()->beginTransaction ();
- try {
- $serviceDAO = new \ServiceDAO ();
- $serviceDAO->setEntityManager ( $this->em );
- $serviceDAO->removeEndpoint ( $endpoint );
-
- $this->em->flush ();
- $this->em->getConnection ()->commit ();
- } catch ( \Exception $e ) {
- $this->em->getConnection ()->rollback ();
- $this->em->close ();
- throw $e;
- }
+ private function deleteEndpointLogic(\EndpointLocation $endpoint)
+ {
+ require_once __DIR__ . '/../DAOs/ServiceDAO.php';
+
+ $this->em->getConnection()->beginTransaction();
+ try {
+ $serviceDAO = new \ServiceDAO();
+ $serviceDAO->setEntityManager($this->em);
+ $serviceDAO->removeEndpoint($endpoint);
+
+ $this->em->flush();
+ $this->em->getConnection()->commit();
+ } catch (\Exception $e) {
+ $this->em->getConnection()->rollback();
+ $this->em->close();
+ throw $e;
+ }
}
/**
@@ -2100,39 +2407,33 @@ private function deleteEndpointLogic (\EndpointLocation $endpoint) {
*
* @returns boolean
*/
- public function EndpointPropSet (\EndpointLocation $endpoint, $endpointPropName) {
- switch (strtolower($endpointPropName)) {
- case 'name':{
- $propValue = $endpoint->getName();
- break;
- }
- case 'url':{
- $propValue = $endpoint->getUrl();
- break;
- }
- case 'interfacename':{
- $propValue = $endpoint->getInterfaceName();
- break;
- }
- case 'description':{
- $propValue = $endpoint->getDescription();
- break;
- }
- case 'email':{
- $propValue = $endpoint->getEmail();
- break;
- }
- case 'monitored': {
- #booleans are always set
- return true;
- }
- default:{
- throw new \Exception("Internal error: endpoint property name ($endpointPropName) not ".
- "recognised. Please contact a GOCDB administrator and report this error.");
- }
- }
-
- return !empty($propValue);
+ public function endpointPropSet(\EndpointLocation $endpoint, $endpointPropName)
+ {
+ switch (strtolower($endpointPropName)) {
+ case 'name':
+ $propValue = $endpoint->getName();
+ break;
+ case 'url':
+ $propValue = $endpoint->getUrl();
+ break;
+ case 'interfacename':
+ $propValue = $endpoint->getInterfaceName();
+ break;
+ case 'description':
+ $propValue = $endpoint->getDescription();
+ break;
+ case 'email':
+ $propValue = $endpoint->getEmail();
+ break;
+ case 'monitored':
+ #booleans are always set
+ return true;
+ default:
+ throw new \Exception("Internal error: endpoint property name ($endpointPropName) not " .
+ "recognised. Please contact a GOCDB administrator and report this error.");
+ }
+
+ return !empty($propValue);
}
/**
@@ -2143,13 +2444,14 @@ public function EndpointPropSet (\EndpointLocation $endpoint, $endpointPropName)
* @param string $name endpoint name being checked
* @return boolean
*/
- public function endpointWithNameExists (\Service $service, $name) {
- foreach ($service->getEndpointLocations() as $endpoint) {
- if ($name == $endpoint->getName()){
- return true;
+ public function endpointWithNameExists(\Service $service, $name)
+ {
+ foreach ($service->getEndpointLocations() as $endpoint) {
+ if ($name == $endpoint->getName()) {
+ return true;
+ }
}
- }
- return false;
+ return false;
}
/**
@@ -2161,24 +2463,25 @@ public function endpointWithNameExists (\Service $service, $name) {
* @return \Endpoint endpoint
* @throws \Exception
*/
- public function getEndpointByName (\Service $service, $name) {
- foreach ($service->getEndpointLocations() as $endpoint) {
- if ($name == $endpoint->getName()){
- return $endpoint;
+ public function getEndpointByName(\Service $service, $name)
+ {
+ foreach ($service->getEndpointLocations() as $endpoint) {
+ if ($name == $endpoint->getName()) {
+ return $endpoint;
+ }
}
- }
-
- //If the endpoint wasn't found, throw exceptions
- throw new \Exception("Endpoint not found");
+ // If the endpoint wasn't found, throw exceptions
+ throw new \Exception("Endpoint not found");
}
- private function checkNumberOfScopes($scopeIds) {
- require_once __DIR__ . '/Config.php';
- $configService = new \org\gocdb\services\Config ();
- $minumNumberOfScopes = $configService->getMinimumScopesRequired ( 'service' );
- if (sizeof ( $scopeIds ) < $minumNumberOfScopes) {
- throw new \Exception ( "A service must have at least " . $minumNumberOfScopes . " optional scope(s) assigned to it." );
+ private function checkNumberOfScopes($scopeIds)
+ {
+ $configService = new Config();
+ $minumNumberOfScopes = $configService->getMinimumScopesRequired('service');
+ if (sizeof($scopeIds) < $minumNumberOfScopes) {
+ throw new \Exception("A service must have at least " . $minumNumberOfScopes .
+ " optional scope(s) assigned to it.");
}
}
@@ -2191,37 +2494,38 @@ private function checkNumberOfScopes($scopeIds) {
* @param \Service $service
* @return associative array
*/
- public function getScopesWithParentScopeInfo(\Service $service) {
- $parentSite = $service->getParentSite ();
- $parentScopes = $parentSite->getScopes ();
- $childScopes = $service->getScopes ();
+ public function getScopesWithParentScopeInfo(\Service $service)
+ {
+ $parentSite = $service->getParentSite();
+ $parentScopes = $parentSite->getScopes();
+ $childScopes = $service->getScopes();
$parentScopesNames = array ();
- foreach ( $parentScopes as $parentScope ) {
- $parentScopesNames [] = $parentScope->getName ();
+ foreach ($parentScopes as $parentScope) {
+ $parentScopesNames[] = $parentScope->getName();
}
$childScopesNames = array ();
- foreach ( $childScopes as $childScope ) {
- $childScopesNames [] = $childScope->getName ();
+ foreach ($childScopes as $childScope) {
+ $childScopesNames[] = $childScope->getName();
}
- $sharedScopesNames = array_intersect ( $childScopesNames, $parentScopesNames );
+ $sharedScopesNames = array_intersect($childScopesNames, $parentScopesNames);
- $scopeNamesNotShared = array_diff ( $childScopesNames, $parentScopesNames );
-
- $ScopeNamesAndParentShareInfo = array ();
- foreach ( $sharedScopesNames as $sharedScopesName ) {
- $ScopeNamesAndParentShareInfo [$sharedScopesName] = true;
+ $scopeNamesNotShared = array_diff($childScopesNames, $parentScopesNames);
+ // scopeNamesAndParentShareInfo
+ $shareInfo = array();
+ foreach ($sharedScopesNames as $sharedScopesName) {
+ $shareInfo[$sharedScopesName] = true;
}
- foreach ( $scopeNamesNotShared as $scopeNameNotShared ) {
- $ScopeNamesAndParentShareInfo [$scopeNameNotShared] = false;
+ foreach ($scopeNamesNotShared as $scopeNameNotShared) {
+ $shareInfo[$scopeNameNotShared] = false;
}
- // can be replaced with ksort($ScopeNamesAndParentShareInfo, SORT_NATURAL); in php>=5.5
- uksort ( $ScopeNamesAndParentShareInfo, 'strcasecmp' );
+ // can be replaced with ksort($shareInfo, SORT_NATURAL); in php>=5.5
+ uksort($shareInfo, 'strcasecmp');
- return $ScopeNamesAndParentShareInfo;
+ return $shareInfo;
}
/**
@@ -2230,11 +2534,12 @@ public function getScopesWithParentScopeInfo(\Service $service) {
* @param string $text string, usually "Y" or "N"
* @return boolean
*/
- private function ptlTexToBool($text) {
- if ($text == "Y") {
- return true;
- } else {
- return false;
- }
+ private function ptlTexToBool($text)
+ {
+ if ($text == "Y") {
+ return true;
+ } else {
+ return false;
+ }
}
}
diff --git a/lib/Gocdb_Services/ServiceType.php b/lib/Gocdb_Services/ServiceType.php
index 48d56a48e..5eabacef6 100644
--- a/lib/Gocdb_Services/ServiceType.php
+++ b/lib/Gocdb_Services/ServiceType.php
@@ -116,7 +116,7 @@ public function deleteServiceType(\ServiceType $serviceType, \User $user = null)
* @param array $newValues array containing the name and description for the
* new service type
* @param \user $user User adding the service type, used for permissions check
- * @return \org\gocdb\services\ServiceType returns created service type
+ * @return \ServiceType returns created service type
*/
public function addServiceType($values, \user $user = null){
//Check the portal is not in read only mode, throws exception if it is
@@ -143,6 +143,8 @@ public function addServiceType($values, \user $user = null){
$serviceType->setName($values['Name']);
//set description
$serviceType->setDescription($values['Description']);
+ //set flag for monitoring exception allowed
+ $serviceType->setAllowMonitoringException($values['AllowMonitoringException']);
$this->em->persist($serviceType);
$this->em->flush();
@@ -186,6 +188,8 @@ public function editServiceType(\ServiceType $serviceType, $newValues, \User $us
$serviceType->setName($newValues['Name']);
//set description
$serviceType->setDescription($newValues['Description']);
+ //flag for monitoring exception allowed
+ $serviceType->setAllowMonitoringException($newValues['AllowMonitoringException']);
$this->em->merge($serviceType);
$this->em->flush();
@@ -270,5 +274,3 @@ private function validate($serviceTypeData) {
}
}
}
-
-
diff --git a/lib/Gocdb_Services/Validate.php b/lib/Gocdb_Services/Validate.php
index dc1d38464..03eaf332d 100644
--- a/lib/Gocdb_Services/Validate.php
+++ b/lib/Gocdb_Services/Validate.php
@@ -1,5 +1,7 @@
schemaXml = simplexml_load_file(__DIR__ . $this::SCHEMA_XML);
+ }
+
+ /* Validates $fieldValue using validation settings from the GOCDB
*
- * Checks the particular object (specified by $Object_Name) for a field
- * ($Field_Name) and gets the validation requirements for this field type.
- * Returns a boolean value as to whether $Field_Value is valid for the field
- * type specified in $Field_Name.
+ * Checks the particular object (specified by $objectName) for a field
+ * ($fieldName) and gets the validation requirements for this field type.
+ * Returns a boolean value as to whether $fieldValue is valid for the field
+ * type specified in $fieldName.
*/
- public function validate($Object_Name, $Field_Name, $Field_Value)
+ public function validate($objectName, $fieldName, $fieldValue)
{
//Check the length of the field value, if too long, throws exception
- $this->checkFieldLength($Object_Name, $Field_Name, $Field_Value);
+ $this->checkFieldLength($objectName, $fieldName, $fieldValue);
//Check the Type of the field value, where this is defined
- $type = $this->Get_Field_value($Object_Name, $Field_Name, 'ftype');
+ $type = $this->getFieldValue($objectName, $fieldName, 'ftype');
if (count($type) != 0) {
- if (strtolower($type) == "string") {
- if (!is_string($Field_Value)) {
- throw new \Exception($Field_Name . " must be a string.");
- }
- } elseif (strtolower($type) == "boolean") {
- if (!is_bool($Field_Value)) {
- throw new \Exception($Field_Name . " must be a boolean.");
+ if (strtolower($type) == "string") {
+ if (!is_string($fieldValue)) {
+ throw new \Exception($fieldName . " must be a string.");
+ }
+ } elseif (strtolower($type) == "boolean") {
+ if (!is_bool($fieldValue)) {
+ throw new \Exception($fieldName . " must be a boolean.");
+ }
+ } else {
+ throw new \Exception("Internal error: validation of data of type $type " .
+ "is not supported by the validation service");
}
- } else {
- throw new \Exception("Internal error: validation of data of type $type is not supported by the validation service");
- }
}
-
- $RegEx = $this->Get_Field_value($Object_Name, $Field_Name, 'regex');
- // If there are no checks to perform then $Field_Value must be valid
- if(count($RegEx) == 0)
+
+ $regEx = $this->getFieldValue($objectName, $fieldName, 'regex');
+ // If there are no checks to perform then $fieldValue must be valid
+ if (count($regEx) == 0) {
return true;
+ }
- if(!preg_match($RegEx, $Field_Value)) {
+ if (!preg_match($regEx, $fieldValue)) {
return false;
}
@@ -68,11 +83,12 @@ public function validate($Object_Name, $Field_Name, $Field_Value)
* Checks the length of inputs against the length specified in the schema.
* @throws \Exception
*/
- private function checkFieldLength($objectName, $fieldName, $fieldValue){
- $length = $this->Get_Field_value($objectName, $fieldName, 'length');
+ private function checkFieldLength($objectName, $fieldName, $fieldValue)
+ {
+ $length = $this->getFieldValue($objectName, $fieldName, 'length');
- if(!count($length) == 0){ //only check length if the schema has a length specified in it
- if(strlen($fieldValue)>$length or $length == 0){
+ if (!count($length) == 0) { //only check length if the schema has a length specified in it
+ if (strlen($fieldValue) > $length or $length == 0) {
throw new \Exception($fieldName . " may not be more than " . $length . " chracters in length");
}
}
@@ -83,37 +99,34 @@ private function checkFieldLength($objectName, $fieldName, $fieldValue){
* Format: $Checks[Check_Name] = $Check_Parameter
* i.e. $Checks[Regular_Expression] = "[Y|N]"
*/
- private function Get_Field_value($Object_Name, $Field_Name, $valueType)
+ private function getFieldValue($objectName, $fieldName, $valueType)
{
- $Schema_XML = simplexml_load_file(__DIR__ . $this::SCHEMA_XML);
- $Entity = $this->Find_Entity($Object_Name, $Schema_XML);
- $Field = $this->Find_Field($Field_Name, $Entity);
- return $Field->$valueType;
+ $entity = $this->findEntity($objectName, $this->schemaXml);
+ $field = $this->findField($fieldName, $entity);
+ return $field->$valueType;
}
- /* Search for the XML for $Object_Name within Schema XML
+ /* Search for the XML for $objectName within Schema XML
* Throw an exeption if this isn't found. */
- private function Find_Entity($Object_Name, $Schema_XML)
+ private function findEntity($objectName, $schemaXml)
{
- foreach($Schema_XML->entity as $entity)
- {
- if ((string) $entity->name == $Object_Name) {
+ foreach ($schemaXml->entity as $entity) {
+ if ((string) $entity->name == $objectName) {
return $entity;
}
}
- throw new \Exception("Object type: $Object_Name not found in schema XML");
+ throw new \Exception("Object type: $objectName not found in schema XML");
}
- private function Find_Field($Field_Name, $Entity)
+ private function findField($fieldName, $entity)
{
- foreach($Entity->field as $Field)
- {
- if(strtoupper((string) $Field->fname) == strtoupper($Field_Name)) {
- return $Field;
+ foreach ($entity->field as $field) {
+ if (strtoupper((string) $field->fname) == strtoupper($fieldName)) {
+ return $field;
}
}
- throw new \Exception("Field Name: $Field_Name not found in schema XML");
+ throw new \Exception("Field Name: $fieldName not found in schema XML");
}
}
diff --git a/lib/MonologConf.php b/lib/MonologConf.php
index 40915dcc4..4a69d2439 100644
--- a/lib/MonologConf.php
+++ b/lib/MonologConf.php
@@ -25,4 +25,3 @@
// You can now use your logger
$log1->addDebug('log1 is now ready');
-
diff --git a/phpcs.xml b/phpcs.xml
index f7625d787..2d1349ca3 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -13,4 +13,10 @@
-->
+
+
+
+
+
+
diff --git a/resources/ApplyScopeTagsToSitesAndServicesRunner.php b/resources/ApplyScopeTagsToSitesAndServicesRunner.php
index 9f916206d..2971a4850 100644
--- a/resources/ApplyScopeTagsToSitesAndServicesRunner.php
+++ b/resources/ApplyScopeTagsToSitesAndServicesRunner.php
@@ -259,5 +259,3 @@
$em->close();
echo $e->getMessage();
}
-
-
diff --git a/resources/ManageAPICredentials/ManageAPICredentialsActions.php b/resources/ManageAPICredentials/ManageAPICredentialsActions.php
new file mode 100644
index 000000000..51e2b895b
--- /dev/null
+++ b/resources/ManageAPICredentials/ManageAPICredentialsActions.php
@@ -0,0 +1,263 @@
+dryRun = $dryRun;
+ $this->entityManager = $entityManager;
+ $this->baseTime = $baseTime;
+ }
+ /**
+ * Find API credentials unused for a number of months.
+ *
+ * Find API credentials which have not been used for a number of months prior to a given base time based
+ * on the credential property lastUseTime.
+ *
+ * @param int $threshold The number of months of no-use prior to $baseTime to use for selection
+ */
+ public function getCreds($threshold, $propertyName)
+ {
+ $qbl = $this->entityManager->createQueryBuilder();
+
+ $qbl->select('cred')
+ ->from('APIAuthentication', 'cred')
+ ->where($qbl->expr()->isNotNull("cred.user")) // cope with legacy entities
+ ->andWhere('cred.' . $propertyName . '< :threshold');
+
+ $timeThresh = clone $this->baseTime;
+
+ if ($threshold > 0) {
+ $timeThresh->sub(new DateInterval("P" . $threshold . "M"));
+ };
+
+ $qbl->setParameter('threshold', $timeThresh->format('Y-m-d 00:00:00'));
+
+ $creds = $qbl->getQuery()->getResult();
+
+ return $creds;
+ }
+ /**
+ * Select API credentials for deletion.
+ *
+ * Find API credentials which have not been used for a given number of months
+ * and delete them or, if dry-run option is true, generate a summary report
+ * of the credentils found.
+ *
+ * @param array $creds Array of credentials to process.
+ * @param \Doctrine\Orm\EntityManager $entitymanager A valid Doctrine Entity Manager
+ * @param \DateTime $baseTime Time from which interval of no-use is measured
+ * @param int $deleteThreshold The number of months of no-use which will trigger deletion
+ * @return array Credentials which were not deleted.
+ */
+ public function deleteCreds($creds, $deleteThreshold)
+ {
+ $deletedCreds = [];
+
+ $serv = new APIAuthenticationService();
+ $serv->setEntityManager($this->entityManager);
+
+ /* @var $apiCred APIAuthentication */
+ foreach ($creds as $apiCred) {
+ if ($this->isOverThreshold($apiCred, $this->baseTime, $deleteThreshold)) {
+ $deletedCreds[] = $apiCred;
+ if (!$this->dryRun) {
+ $serv->deleteAPIAuthentication($apiCred);
+ }
+ }
+ }
+ if ($this->dryRun) {
+ $this->reportDryRun($deletedCreds, "deleting");
+ }
+
+ return array_udiff($creds, $deletedCreds, array($this, 'compareCredIds'));
+ }
+ /**
+ * Send of warning emails where credentials have not been used for a given number of months
+ *
+ * Find API credentials from the input array which have not been used for a given number of months
+ * and send emails to the owners and site address, taken from the credential object,
+ * warning of impending deletion if the period of no-use reaches a given threshold.
+ * If dry-run option is true, generate a summary report of the credentials found
+ * instead of sending emails.
+ *
+ * @param array $creds Array of credentials to process.
+ * @param int $warningThreshold The number of months of no-use which triggers warning emails
+ * @param int $deleteThreshold The number of months of no-use which will trigger deletion
+ * @param string $fromEmail Email address to use as sender's (From:) address
+ * @param string $replyToEmail Email address for replies (Reply-To:)
+ * @return array Array of credentials identifed for sending warning emails
+ */
+ public function warnUsers(
+ $creds,
+ $warningThreshold,
+ $deletionThreshold,
+ $fromEmail,
+ $replyToEmail
+ ) {
+ $warnedCreds = [];
+
+ /* @var $api APIAuthentication */
+ foreach ($creds as $apiCred) {
+ // The credentials list is pre-selected based on the given threshold in the query
+ // so this check is probably redundant.
+ if ($this->isOverThreshold($apiCred, $this->baseTime, $warningThreshold)) {
+ $lastUsed = $apiCred->getLastUseTime();
+ $lastUseMonths = $this->baseTime->diff($lastUsed)->format('%m');
+
+ if (!$this->dryRun) {
+ $this->sendWarningEmail(
+ $fromEmail,
+ $replyToEmail,
+ $apiCred,
+ intval($lastUseMonths),
+ $deletionThreshold
+ );
+ }
+
+ $warnedCreds[] = $apiCred;
+ }
+ }
+
+ if ($this->dryRun) {
+ $this->reportDryRun($warnedCreds, "sending warning emails");
+ }
+
+ return array_udiff($creds, $warnedCreds, array($this, 'compareCredIds'));
+ }
+/**
+ * @return boolean true if the credential has not been used within $threshold months, else false
+ */
+ private function isOverThreshold(APIAuthentication $cred, DateTime $baseTime, $threshold)
+ {
+ $lastUsed = $cred->getLastUseTime();
+
+ $diffTime = $baseTime->diff($lastUsed);
+ $lastUseMonths = ($diffTime->y * 12) + $diffTime->m;
+
+ return $lastUseMonths >= $threshold;
+ }
+/**
+ * Helper function to check if two API credentials have the same id.
+ *
+ * @return integer zero if equal, -1 if id1 < id2, 1 if id1 > id2
+ *
+*/
+ private function compareCredIds(APIAuthentication $cred1, APIAuthentication $cred2)
+ {
+ $id1 = $cred1->getId();
+ $id2 = $cred2->getId();
+
+ if ($id1 == $id2) {
+ return 0;
+ };
+
+ return $id1 > $id2 ? 1 : -1;
+ }
+
+/**
+ * Format and send warning emails.
+ *
+ * Send emails to API credential owner and the registered site address warning of impending credential deletion
+ * if the credential remains unused until a given threshold of months.
+ *
+ * @param string $fromEmail Email address to use as sender's (From:) address
+ * @param string $replyToEmail Email address for replies (Reply-To:)
+ * @param \APIAuthentication $api Credential to warn about
+ * @param int $elapsedMonths The number of months of non-use so far.
+ * @param int $deleteionThreshold The number of months of no-use which will trigger deletion if reached.
+ * @return void
+ */
+ private function sendWarningEmail(
+ $fromEmail,
+ $replyToEmail,
+ \APIAuthentication $api,
+ $elapsedMonths,
+ $deletionThreshold
+ ) {
+ $user = $api->getUser();
+ $userEmail = $user->getEmail();
+ $siteName = $api->getParentSite()->getShortName();
+ $siteEmail = $siteName . ' <' . $api->getParentSite()->getEmail() . '>';
+
+ $headersArray = array ("From: $fromEmail",
+ "Cc: $siteEmail");
+ if (strlen($replyToEmail) > 0 && $fromEmail !== $replyToEmail) {
+ $headersArray[] = "Reply-To: $replyToEmail";
+ }
+ $headers = join("\r\n", $headersArray);
+
+ $subject = "GOCDB: Site API credential deletion notice";
+
+ $body = "Dear " . $user->getForename() . ",\n\n" .
+ "The API credential associated with the following identifier registered\n" .
+ "at site $siteName has not been used during\n" .
+ "the last $elapsedMonths months and will be deleted if this period of inactivity\n" .
+ "reaches $deletionThreshold months.\n\n";
+
+ $body .= "Identifier: " . $api->getIdentifier() . "\n";
+ $body .= "Owner email: " . $userEmail . "\n";
+
+ $body .= "\n";
+ $body .= "Use of the credential will prevent its deletion.\n";
+ $body .= "\nRegards,\nGOCDB Administrators\n";
+
+ // Send the email (or not, according to local configuration)
+ Factory::getEmailService()->send($userEmail, $subject, $body, $headers);
+ }
+/**
+ * Generate a summary report.
+ *
+ * Generate a report to stdout summarising information about each credential in an array when
+ * a dry-run operation is in progress.
+ *
+ * @param array $creds Array of API credential objects to be summarised.
+ * @param string $text Brief description of the operation which would have been
+ * performed without dry-run to be included in the report.
+ * @return void
+ */
+ private function reportDryRun(array $creds, $text)
+ {
+ if (count($creds) == 0) {
+ print("Dry run: No matching credentials found for $text.\n");
+ return;
+ }
+
+ print("Dry run: Found " . count($creds) . " credentials for $text.\n");
+
+ foreach ($creds as $api) {
+ print("Dry run: Processing credential id " . $api->getId() . "\n" .
+ " Identifier: " . $api->getIdentifier() . "\n" .
+ " User email: " . $api->getUser()->getEmail() . "\n" .
+ " Site: " . $api->getParentSite()->getShortName() . "\n" .
+ " Last used: " . $api->getLastUseTime() // DateTimeInterface::ISO8601
+ ->format("Y-m-d\\TH:i:sO") . "\n"
+ );
+ }
+ }
+}
diff --git a/resources/ManageAPICredentials/ManageUnusedAPICredentials.php b/resources/ManageAPICredentials/ManageUnusedAPICredentials.php
new file mode 100644
index 000000000..88009d04f
--- /dev/null
+++ b/resources/ManageAPICredentials/ManageUnusedAPICredentials.php
@@ -0,0 +1,74 @@
+setLocalInfoOverride($_SERVER['SERVER_NAME']);
+
+$configService = \Factory::getConfigService();
+$fromEmail = (string) $configService->getEmailFrom();
+$replyToEmail = (string) $configService->getEmailTo();
+
+try {
+ $options = new ManageUnusedAPICredentialsOptions();
+
+ if ($options->isShowHelp()) {
+ return;
+ }
+
+ $baseTime = new DateTime("now", new DateTimeZone('UTC'));
+
+ $actions = new ManageAPICredentialsActions($options->isDryRun(), $entityManager, $baseTime);
+
+ $creds = $actions->getCreds($options->getThreshold(), 'lastUseTime');
+
+ if ($options->isDeleteEnabled()) {
+ $creds = $actions->deleteCreds(
+ $creds,
+ $options->getDelete()
+ );
+ }
+
+ if ($options->isWarnEnabled()) {
+ $actions->warnUsers(
+ $creds,
+ $options->getWarn(),
+ $options->getDelete(),
+ $fromEmail,
+ $replyToEmail
+ );
+ }
+} catch (InvalidArgumentException $except) {
+ ManageUnusedAPICredentialsOptions::usage($except->getMessage());
+}
diff --git a/resources/ManageAPICredentials/ManageUnusedAPICredentialsOptions.php b/resources/ManageAPICredentials/ManageUnusedAPICredentialsOptions.php
new file mode 100644
index 000000000..8463c6e8b
--- /dev/null
+++ b/resources/ManageAPICredentials/ManageUnusedAPICredentialsOptions.php
@@ -0,0 +1,140 @@
+getOptions();
+ }
+ /**
+ * @throws \InvInvalidArgumentException If errors found in argument processing
+ */
+ public function getOptions()
+ {
+ $shortOptions = 'hw:d:';
+
+ $longOptions = [
+ 'help',
+ 'dry-run',
+ 'warning_threshold:',
+ 'deletion_threshold:'
+ ];
+
+ // Beware that getopt is not clever at spotting invalid/misspelled arguments
+ $given = getopt($shortOptions, $longOptions);
+
+ if ($given === false) {
+ throw new InvalidArgumentException('failed to parse command line arguments');
+ }
+
+ if ($this->getBoolOption($given, 'help', 'h')) {
+ $this->usage();
+ $this->showHelp = true;
+ return;
+ }
+
+ $this->dryRun = isset($given['dry-run']);
+
+ $this->delete = $this->getValOption($given, 'deletion_threshold', 'd');
+ $this->warn = $this->getValOption($given, 'warning_threshold', 'w');
+
+ if (!(is_null($this->delete) || is_null($this->warn))) {
+ if ($this->delete < $this->warn) {
+ throw new InvalidArgumentException(
+ "deletion_threshold must be greater than warning_threshold"
+ );
+ }
+ }
+ return;
+ }
+ private function getValOption($given, $long, $short)
+ {
+ if (isset($given[$long]) || isset($given[$short])) {
+ $tValGiven = isset($given[$short]) ? $given[$short] : $given[$long];
+ return $this->positiveInteger($tValGiven, $long);
+ }
+ return;
+ }
+ private function getBoolOption($given, $long, $short)
+ {
+ return isset($given[$long]) || isset($given[$short]);
+ }
+ private function positiveInteger($val, $txt)
+ {
+ if ((string)abs((int)$val) != $val) {
+ throw new InvalidArgumentException(
+ "$txt must be integer and greater than zero . Received: $val"
+ );
+ }
+ return (int)$val;
+ }
+ public static function usage($message = '')
+ {
+ if ($message != '') {
+ print
+ (
+ "Error: $message\n"
+ );
+ }
+ print
+ (
+ "Usage: php ManageAPICredentials.php [--help | -h] [--dry-run] \\\ \n" .
+ " [[--warning_threshold | -w] MONTHS ] \\\ \n" .
+ " [[--deletion_threshold | -d ] MONTHS ] \n" .
+ "Options: \n" .
+ " -h, --help Print this message.\n" .
+ " --dry-run Report but do nothing.\n" .
+ " -w, --warning_threshold MONTHS Email the owning user about credentials \n" .
+ " which have not been used for MONTHS months.\n" .
+ " -d, --deletion_threshold MONTHS Delete credentials which have not been used\n" .
+ " for MONTHS months.\n"
+ );
+ }
+ public function isShowHelp()
+ {
+ return $this->showHelp;
+ }
+ public function isDryRun()
+ {
+ return $this->dryRun;
+ }
+ public function isDeleteEnabled()
+ {
+ return !is_null($this->getDelete());
+ }
+ public function isWarnEnabled()
+ {
+ return !is_null($this->getWarn());
+ }
+ public function getWarn()
+ {
+ return $this->warn;
+ }
+ public function getDelete()
+ {
+ return $this->delete;
+ }
+ /**
+ * The delete threshold may not be given in which case the warning threshold should be used.
+ * Note that it is an error is delete is greater than warning.
+ */
+ public function getThreshold()
+ {
+ return $this->isWarnEnabled() ? $this->getWarn() : $this->getDelete();
+ }
+}
diff --git a/resources/QueryPopulateSSO_UsernameRunner.php b/resources/QueryPopulateSSO_UsernameRunner.php
index c420e1dfe..e3fae5a18 100644
--- a/resources/QueryPopulateSSO_UsernameRunner.php
+++ b/resources/QueryPopulateSSO_UsernameRunner.php
@@ -74,5 +74,3 @@
function cleanDN($dn) {
return trim(str_replace(' ', '%20', $dn));
}
-
-
diff --git a/tests/DoctrineTestSuite1.php b/tests/DoctrineTestSuite1.php
index 0f6eab43c..a7d11af27 100644
--- a/tests/DoctrineTestSuite1.php
+++ b/tests/DoctrineTestSuite1.php
@@ -19,9 +19,12 @@
require_once __DIR__ . '/doctrine/ExtensionsTest.php';
require_once __DIR__ . '/doctrine/Scoped_IPIQuery_Test1.php';
require_once __DIR__ . '/doctrine/DowntimeServiceEndpointTest1.php';
+require_once __DIR__ . '/doctrine/ServiceTypeTest.php';
require_once __DIR__ . '/unit/lib/Gocdb_Services/RoleActionAuthorisationServiceTest.php';
require_once __DIR__ . '/unit/lib/Gocdb_Services/RoleActionMappingServiceTest.php';
require_once __DIR__ . '/unit/lib/Gocdb_Services/ScopeServiceTest.php';
+require_once __DIR__ . '/unit/lib/Gocdb_Services/ServiceServiceTest.php';
+require_once __DIR__ . '/unit/lib/Gocdb_Services/ServiceTypeServiceTest.php';
require_once __DIR__ . '/unit/lib/Gocdb_Services/UserServiceTest.php';
require_once __DIR__ . '/unit/lib/Gocdb_Services/SiteServiceTest.php';
require_once __DIR__ . '/unit/lib/Gocdb_Services/RoleServiceTest2.php';
@@ -29,8 +32,8 @@
require_once __DIR__ . '/writeAPI/siteMethods.php';
require_once __DIR__ . '/writeAPI/serviceMethods.php';
require_once __DIR__ . '/writeAPI/endpointMethods.php';
-
-require_once __DIR__ . '/unit/lib/Gocdb_Services/ServiceServiceTest.php';
+require_once __DIR__ . '/resourcesTests/ManageUnusedAPICredentialsTest.php';
+require_once __DIR__ . '/resourcesTests/ManageUnrenewedAPICredentialsTest.php';
use PHPUnit_Framework_TestSuite;
@@ -62,15 +65,19 @@ public static function suite()
$suite->addTestSuite('RoleActionAuthorisationServiceTest');
$suite->addTestSuite('RoleActionMappingServiceTest');
$suite->addTestSuite('ScopeServiceTest');
+ $suite->addTestSuite('org\gocdb\tests\ServiceServiceTest');
+ $suite->addTestSuite('org\gocdb\tests\ServiceTypeTest');
+ $suite->addTestSuite('org\gocdb\tests\ServiceTypeServiceTest');
$suite->addTestSuite('UserServiceTest');
- $suite->addTestSuite('SiteServiceTest');
+ $suite->addTestSuite('org\gocdb\tests\SiteServiceTest');
$suite->addTestSuite('RoleServiceTest2');
$suite->addTestSuite('org\gocdb\tests\APIAuthenticationServiceTest');
$suite->addTestSuite('WriteAPIsiteMethodsTests');
$suite->addTestSuite('WriteAPIserviceMethodsTests');
$suite->addTestSuite('WriteAPIendpointMethodsTests');
+ $suite->addTestSuite('org\gocdb\tests\ManageUnusedAPICredentialsTest');
+ $suite->addTestSuite('org\gocdb\tests\ManageUnrenewedAPICredentialsTest');
- $suite->addTestSuite('ServiceServiceTest');
return $suite;
}
diff --git a/tests/doctrine/ServiceTypeTest.php b/tests/doctrine/ServiceTypeTest.php
new file mode 100644
index 000000000..801dcaa9a
--- /dev/null
+++ b/tests/doctrine/ServiceTypeTest.php
@@ -0,0 +1,148 @@
+createFlatXMLDataSet(dirname(__FILE__) . '/truncateDataTables.xml');
+ }
+
+ /**
+ * Overridden.
+ */
+ protected function getSetUpOperation()
+ {
+ // CLEAN_INSERT is default
+ //return PHPUnit_Extensions_Database_Operation_Factory::CLEAN_INSERT();
+ //return PHPUnit_Extensions_Database_Operation_Factory::UPDATE();
+ //return PHPUnit_Extensions_Database_Operation_Factory::NONE();
+ //
+ // Issue a DELETE from which is more portable than a
+ // TRUNCATE table (some DBs require high privileges for truncate statements
+ // and also do not allow truncates across tables with FK contstraints e.g. Oracle)
+ return PHPUnit_Extensions_Database_Operation_Factory::DELETE_ALL();
+ }
+
+ /**
+ * Overridden.
+ */
+ protected function getTearDownOperation()
+ {
+ // NONE is default
+ return PHPUnit_Extensions_Database_Operation_Factory::NONE();
+ }
+
+ /**
+ * Sets up the fixture, e.g create a new entityManager for each test run
+ * This method is called before each test method is executed.
+ */
+ protected function setUp()
+ {
+ parent::setUp();
+ $this->em = $this->createEntityManager();
+ }
+
+ /**
+ * @todo Still need to setup connection to different databases.
+ * @return EntityManager
+ */
+ private function createEntityManager()
+ {
+ $entityManager = null;
+ require dirname(__FILE__) . '/bootstrap_doctrine.php';
+ return $entityManager;
+ }
+
+ /**
+ * Called after setUp() and before each test. Used for common assertions
+ * across all tests.
+ */
+ protected function assertPreConditions()
+ {
+ $con = $this->getConnection();
+ $fixture = dirname(__FILE__) . '/truncateDataTables.xml';
+ $tables = simplexml_load_file($fixture);
+
+ foreach ($tables as $tableName) {
+ //print $tableName->getName() . "\n";
+ $sql = "SELECT * FROM " . $tableName->getName();
+ $result = $con->createQueryTable('results_table', $sql);
+ //echo 'row count: '.$result->getRowCount() ;
+ if ($result->getRowCount() != 0) {
+ throw new RuntimeException("Invalid fixture. Table has rows: " . $tableName->getName());
+ }
+ }
+ }
+
+ /**
+ * Any function with test at the start of the name will execute with PHPUnit
+ */
+ public function testServiceType()
+ {
+ print __METHOD__ . "\n";
+
+ /**
+ * Check some logic related to monitoring exceptions in ServiceType entity
+ */
+
+ $type1 = TestUtil::createSampleServiceType(
+ 'this is a test serviceType',
+ 'type1'
+ );
+
+ // Default assumed to disallow monitoring exception
+ $this->assertEquals($type1->getAllowMonitoringException(), 0);
+ // Set to true and check return is the current state
+ $this->assertEquals($type1->setAllowMonitoringException(1), 0);
+ // Check that it's changed
+ $this->assertEquals($type1->getAllowMonitoringException(), 1);
+ }
+}
diff --git a/tests/doctrine/TestUtil.php b/tests/doctrine/TestUtil.php
index eedafeeba..7effe2afd 100644
--- a/tests/doctrine/TestUtil.php
+++ b/tests/doctrine/TestUtil.php
@@ -56,10 +56,10 @@ public static function createSampleService($label){
return $serv;
}
- public static function createSampleServiceType($name){
+ public static function createSampleServiceType($description, $name){
$stype = new ServiceType();
$stype->setName($name);
- $stype->setDescription('sample service type');
+ $stype->setDescription($description);
return $stype;
}
diff --git a/tests/miscTests/PI_Extensions_Param_ParsingTest.php b/tests/miscTests/PI_Extensions_Param_ParsingTest.php
index d3f57e511..4266529f7 100644
--- a/tests/miscTests/PI_Extensions_Param_ParsingTest.php
+++ b/tests/miscTests/PI_Extensions_Param_ParsingTest.php
@@ -793,5 +793,3 @@ public function test_ExensionsParser2() {
}
-
-
diff --git a/tests/miscTests/ValidateLocalInfoXML.php b/tests/miscTests/ValidateLocalInfoXML.php
new file mode 100644
index 000000000..86e81d96d
--- /dev/null
+++ b/tests/miscTests/ValidateLocalInfoXML.php
@@ -0,0 +1,22 @@
+load('../../config/local_info.xml');
+
+if (!$xml->schemaValidate('../../config/local_info.xsd')) {
+ print 'Errors found. ';
+ print libxml_display_errors();
+} else {
+ print 'Validated. No errors found. ';
+}
diff --git a/tests/resources/QueryPI_GetXmlOutput.php b/tests/resources/QueryPI_GetXmlOutput.php
index dec30ad40..518f2ef2b 100644
--- a/tests/resources/QueryPI_GetXmlOutput.php
+++ b/tests/resources/QueryPI_GetXmlOutput.php
@@ -177,8 +177,3 @@
else {
echo "Error no valid arg given\n";
}
-
-
-
-
-
diff --git a/tests/resourcesTests/ManageAPICredentialsTestUtils.php b/tests/resourcesTests/ManageAPICredentialsTestUtils.php
new file mode 100644
index 000000000..32a7f53b4
--- /dev/null
+++ b/tests/resourcesTests/ManageAPICredentialsTestUtils.php
@@ -0,0 +1,66 @@
+entityManager = $entityManager;
+ $this->serviceTestUtil = new ServiceTestUtil();
+ }
+ /**
+ * Create a number of unique API authentication credentials, evenly spaced each
+ * with last used time and last renewed time a given number of months before the
+ * previous, starting the given number of months before the current time.
+ *
+ * @param integer $number The number of credentials to create
+ * @param integer $intervalMonths The interval in months between credentials used to
+ * set lastUseTime and lastRenewTime
+ * @return \DateTime Time used as base: the first credential will have time values
+ * $intervalMonths older than this
+ */
+ public function createTestAuthEnts($number, $intervalMonths)
+ {
+ list($user, $site, $siteService) =
+ $this->serviceTestUtil->createGocdbEntities($this->entityManager);
+
+ $baseTime = new DateTime('now', new DateTimeZone('UTC'));
+
+ $type = 'X.509';
+
+ $time = clone $baseTime;
+
+ for ($count = 1; $count <= $number; $count++) {
+ // $useTime will be decremented by 6M for each loop
+ $time->sub(new DateInterval('P' . $intervalMonths . 'M'));
+ $ident = '/CN=A Dummy Subject ' . $count;
+ $authEnt = $siteService->addAPIAuthEntity(
+ $site,
+ $user,
+ array(
+ 'IDENTIFIER' => $ident,
+ 'TYPE' => $type,
+ 'ALLOW_WRITE' => false
+ )
+ );
+ $authEnt->setLastUseTime($time);
+ $authEnt->setLastRenewTime($time);
+ }
+ return $baseTime;
+ }
+}
diff --git a/tests/resourcesTests/ManageUnrenewedAPICredentialsTest.php b/tests/resourcesTests/ManageUnrenewedAPICredentialsTest.php
new file mode 100644
index 000000000..6065dea04
--- /dev/null
+++ b/tests/resourcesTests/ManageUnrenewedAPICredentialsTest.php
@@ -0,0 +1,167 @@
+dbOpsFactory = new PHPUnit_Extensions_Database_Operation_Factory();
+ }
+ /**
+ * Overridden.
+ */
+ public static function setUpBeforeClass()
+ {
+ parent::setUpBeforeClass();
+ echo "\n\n-------------------------------------------------\n";
+ echo "Executing ManageUnrenewedAPICredentialsTest. . .\n";
+ }
+ /**
+ * Overridden. Returns the test database connection.
+ * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
+ */
+ protected function getConnection()
+ {
+ require_once __DIR__ . '/../doctrine/bootstrap_pdo.php';
+ return getConnectionToTestDB();
+ }
+ /**
+ * Overridden. Returns the test dataset.
+ * Defines how the initial state of the database should look before each test is executed.
+ * @return PHPUnit_Extensions_Database_DataSet_IDataSet
+ */
+ protected function getDataSet()
+ {
+ $dataset = $this->createFlatXMLDataSet(__DIR__ . '/../doctrine/truncateDataTables.xml');
+ return $dataset;
+ // Use below to return an empty data set if we don't want to truncate and seed
+ //return new PHPUnit_Extensions_Database_DataSet_DefaultDataSet();
+ }
+ /**
+ * Overridden.
+ */
+ protected function getSetUpOperation()
+ {
+ // CLEAN_INSERT is default
+ //return PHPUnit_Extensions_Database_Operation_Factory::CLEAN_INSERT();
+ //return PHPUnit_Extensions_Database_Operation_Factory::UPDATE();
+ //return PHPUnit_Extensions_Database_Operation_Factory::NONE();
+ //
+ // Issue a DELETE from which is more portable than a
+ // TRUNCATE table (some DBs require high privileges for truncate statements
+ // and also do not allow truncates across tables with FK contstraints e.g. Oracle)
+ return $this->dbOpsFactory->DELETE_ALL();
+ }
+ /**
+ * Overridden.
+ */
+ protected function getTearDownOperation()
+ {
+ // NONE is default
+ return $this->dbOpsFactory->NONE();
+ }
+ /**
+ * Sets up the fixture, e.g create a new entityManager for each test run
+ * This method is called before each test method is executed.
+ */
+ protected function setUp()
+ {
+ parent::setUp();
+ $this->entityManager = $this->createEntityManager();
+ // Pass the Entity Manager into the Factory to allow Gocdb_Services
+ // to use other Gocdb_Services.
+ \Factory::setEntityManager($this->entityManager);
+
+ date_default_timezone_set("UTC");
+ }
+ /**
+ * Run after each test function to prevent pile-up of database connections.
+ */
+ protected function tearDown()
+ {
+ parent::tearDown();
+ if (!is_null($this->entityManager)) {
+ $this->entityManager->getConnection()->close();
+ }
+ }
+ /**
+ * @return EntityManager
+ */
+ private function createEntityManager()
+ {
+ $entityManager = null; // Initialise in local scope to avoid unused variable warnings
+ require __DIR__ . '/../doctrine/bootstrap_doctrine.php';
+ return $entityManager;
+ }
+ public function testLastRenewTime()
+ {
+ print __METHOD__ . "\n";
+
+ // Create 8 credentials, each 2 month apart.
+ // 2 months chosen so the exact definition of a month doesn't matter.
+ $utils = new ManageAPICredentialsTestUtils($this->entityManager);
+ $baseTime = $utils->createTestAuthEnts(8, 2);
+
+ $entityManager = $this->createEntityManager();
+
+ $actions = new ManageAPICredentialsActions(false, $entityManager, $baseTime);
+
+ // Fetch credentials not renewed in the last 5 months - should be 6.
+ $creds = $actions->getCreds(5, 'lastRenewTime');
+
+ $this->assertCount(
+ 6,
+ $creds,
+ 'Failed to filter credentials based on last renew time.'
+ );
+
+ // remove credentials last renewed more than 9 months ago
+ // there should be 2 left after this operation (as 2 of
+ // the 6 fetched above have been renewed with 9 months).
+ $creds = $actions->deleteCreds($creds, 9);
+
+ $this->assertCount(
+ 2,
+ $creds,
+ 'Failed to delete credential by renew time.'
+ );
+
+ // If we now repeat the original query there should be just 4
+ // credential following the delete.
+ $creds = $actions->getCreds(5, 'lastRenewTime');
+
+ $this->assertCount(
+ 2,
+ $creds,
+ 'Unexpected credential count following deletion.'
+ );
+ }
+}
diff --git a/tests/resourcesTests/ManageUnusedAPICredentialsTest.php b/tests/resourcesTests/ManageUnusedAPICredentialsTest.php
new file mode 100644
index 000000000..ca5dd4a33
--- /dev/null
+++ b/tests/resourcesTests/ManageUnusedAPICredentialsTest.php
@@ -0,0 +1,164 @@
+dbOpsFactory = new PHPUnit_Extensions_Database_Operation_Factory();
+ }
+ /**
+ * Overridden.
+ */
+ public static function setUpBeforeClass()
+ {
+ parent::setUpBeforeClass();
+ echo "\n\n-------------------------------------------------\n";
+ echo "Executing ManageUnusedAPICredentialsTest. . .\n";
+ }
+ /**
+ * Overridden. Returns the test database connection.
+ * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
+ */
+ protected function getConnection()
+ {
+ require_once __DIR__ . '/../doctrine/bootstrap_pdo.php';
+ return getConnectionToTestDB();
+ }
+ /**
+ * Overridden. Returns the test dataset.
+ * Defines how the initial state of the database should look before each test is executed.
+ * @return PHPUnit_Extensions_Database_DataSet_IDataSet
+ */
+ protected function getDataSet()
+ {
+ $dataset = $this->createFlatXMLDataSet(__DIR__ . '/../doctrine/truncateDataTables.xml');
+ return $dataset;
+ // Use below to return an empty data set if we don't want to truncate and seed
+ //return new PHPUnit_Extensions_Database_DataSet_DefaultDataSet();
+ }
+ /**
+ * Overridden.
+ */
+ protected function getSetUpOperation()
+ {
+ // CLEAN_INSERT is default
+ //return PHPUnit_Extensions_Database_Operation_Factory::CLEAN_INSERT();
+ //return PHPUnit_Extensions_Database_Operation_Factory::UPDATE();
+ //return PHPUnit_Extensions_Database_Operation_Factory::NONE();
+ //
+ // Issue a DELETE from which is more portable than a
+ // TRUNCATE table (some DBs require high privileges for truncate statements
+ // and also do not allow truncates across tables with FK contstraints e.g. Oracle)
+ return $this->dbOpsFactory->DELETE_ALL();
+ }
+ /**
+ * Overridden.
+ */
+ protected function getTearDownOperation()
+ {
+ // NONE is default
+ return $this->dbOpsFactory->NONE();
+ }
+ /**
+ * Sets up the fixture, e.g create a new entityManager for each test run
+ * This method is called before each test method is executed.
+ */
+ protected function setUp()
+ {
+ parent::setUp();
+ $this->entityManager = $this->createEntityManager();
+ // Pass the Entity Manager into the Factory to allow Gocdb_Services
+ // to use other Gocdb_Services.
+ \Factory::setEntityManager($this->entityManager);
+
+ date_default_timezone_set("UTC");
+ }
+ /**
+ * Run after each test function to prevent pile-up of database connections.
+ */
+ protected function tearDown()
+ {
+ parent::tearDown();
+ if (!is_null($this->entityManager)) {
+ $this->entityManager->getConnection()->close();
+ }
+ }
+ /**
+ * @return EntityManager
+ */
+ private function createEntityManager()
+ {
+ $entityManager = null; // Initialise in local scope to avoid unused variable warnings
+ require __DIR__ . '/../doctrine/bootstrap_doctrine.php';
+ return $entityManager;
+ }
+ public function testLastUseTime()
+ {
+ print __METHOD__ . "\n";
+
+ $utils = new ManageAPICredentialsTestUtils($this->entityManager);
+ $baseTime = $utils->createTestAuthEnts(3, 6);
+
+ $entityManager = $this->createEntityManager();
+
+ $actions = new ManageAPICredentialsActions(false, $entityManager, $baseTime);
+
+ // Fetch credentials not used in the last 7 months - should be 2
+ $creds = $actions->getCreds(7, 'lastUseTime');
+
+ $this->assertCount(
+ 2,
+ $creds,
+ 'Failed to filter credentials based on last use time.'
+ );
+
+ // remove credentials last used more than 13 months ago
+ // there should be one left after this operation
+ $creds = $actions->deleteCreds($creds, 13);
+
+ $this->assertCount(
+ 1,
+ $creds,
+ 'Failed to delete credential based on last use time.'
+ );
+
+ // If we now repeat the original query there should be just one
+ // credential following the delete.
+ $creds = $actions->getCreds(7, 'lastUseTime');
+
+ $this->assertCount(
+ 1,
+ $creds,
+ 'Unexpected credential count following deletion based on last use time.'
+ );
+ }
+}
diff --git a/tests/unit/lib/Gocdb_Services/APIAuthenticationServiceTest.php b/tests/unit/lib/Gocdb_Services/APIAuthenticationServiceTest.php
index 9f9de89bb..3be93251c 100644
--- a/tests/unit/lib/Gocdb_Services/APIAuthenticationServiceTest.php
+++ b/tests/unit/lib/Gocdb_Services/APIAuthenticationServiceTest.php
@@ -22,7 +22,7 @@
use PHPUnit_Extensions_Database_Operation_Factory;
use PHPUnit_Extensions_Database_TestCase;
use RuntimeException;
-use ServiceTestUtil;
+use org\gocdb\tests\ServiceTestUtil;
use TestUtil;
/**
@@ -34,6 +34,7 @@ class APIAuthEnticationServiceTest extends PHPUnit_Extensions_Database_TestCase
{
private $entityManager;
private $dbOpsFactory;
+ private $serviceTestUtil;
public function __construct()
{
@@ -41,6 +42,7 @@ public function __construct()
// Use a local instance to avoid Mess Detector's whinging about avoiding
// static access.
$this->dbOpsFactory = new PHPUnit_Extensions_Database_Operation_Factory();
+ $this->serviceTestUtil = new ServiceTestUtil();
}
/**
* Overridden.
@@ -154,22 +156,8 @@ public function testGetAPIAuthentication()
{
print __METHOD__ . "\n";
- $siteData = ServiceTestUtil::getSiteData($this->entityManager);
- $siteService = ServiceTestUtil::getSiteService($this->entityManager);
- $site = ServiceTestUtil::createAndAddSite($this->entityManager, $siteData);
-
- $user = TestUtil::createSampleUser('Beta', 'User');
- $user->setAdmin(true);
-
- $identifier = TestUtil::createSampleUserIdentifier('X.509', '/Beta.User');
- ServiceTestUtil::persistAndFlush($this->entityManager, $identifier);
-
- $user->addUserIdentifierDoJoin($identifier);
-
- ServiceTestUtil::persistAndFlush($this->entityManager, $user);
-
- $authEntServ = new APIAuthenticationService();
- $authEntServ->setEntityManager($this->entityManager);
+ list($user, $site, $siteService, $authEntServ) =
+ $this->serviceTestUtil->createGocdbEntities($this->entityManager);
$this->assertTrue(
$authEntServ instanceof APIAuthenticationService,
diff --git a/tests/unit/lib/Gocdb_Services/ServiceServiceTest.php b/tests/unit/lib/Gocdb_Services/ServiceServiceTest.php
index 788a769d1..4be36998b 100644
--- a/tests/unit/lib/Gocdb_Services/ServiceServiceTest.php
+++ b/tests/unit/lib/Gocdb_Services/ServiceServiceTest.php
@@ -1,217 +1,467 @@
createFlatXMLDataSet(__DIR__ . '/../../../doctrine/truncateDataTables.xml');
- // Use below to return an empty data set if we don't want to truncate and seed
- //return new PHPUnit_Extensions_Database_DataSet_DefaultDataSet();
- }
+ /**
+ * Overridden. Returns the test dataset.
+ * Defines how the initial state of the database should look before each test is executed.
+ * @return PHPUnit_Extensions_Database_DataSet_IDataSet
+ */
+ protected function getDataSet()
+ {
+ return $this->createFlatXMLDataSet(__DIR__ . '/../../../doctrine/truncateDataTables.xml');
+ }
- /**
- * Overridden.
- */
- protected function getSetUpOperation() {
- // CLEAN_INSERT is default
- //return PHPUnit_Extensions_Database_Operation_Factory::CLEAN_INSERT();
- //return PHPUnit_Extensions_Database_Operation_Factory::UPDATE();
- //return PHPUnit_Extensions_Database_Operation_Factory::NONE();
- //
- // Issue a DELETE from which is more portable than a
- // TRUNCATE table (some DBs require high privileges for truncate statements
- // and also do not allow truncates across tables with FK contstraints e.g. Oracle)
- return PHPUnit_Extensions_Database_Operation_Factory::DELETE_ALL();
- }
+ /**
+ * Overridden.
+ */
+ protected function getSetUpOperation()
+ {
+ // CLEAN_INSERT is default
+ //return PHPUnit_Extensions_Database_Operation_Factory::CLEAN_INSERT();
+ //return PHPUnit_Extensions_Database_Operation_Factory::UPDATE();
+ //return PHPUnit_Extensions_Database_Operation_Factory::NONE();
+ //
+ // Issue a DELETE from which is more portable than a
+ // TRUNCATE table (some DBs require high privileges for truncate statements
+ // and also do not allow truncates across tables with FK contstraints e.g. Oracle)
+ return PHPUnit_Extensions_Database_Operation_Factory::DELETE_ALL();
+ }
- /**
- * Overridden.
- */
- protected function getTearDownOperation() {
- // NONE is default
- return PHPUnit_Extensions_Database_Operation_Factory::NONE();
- }
+ /**
+ * Overridden.
+ */
+ protected function getTearDownOperation()
+ {
+ // NONE is default
+ return PHPUnit_Extensions_Database_Operation_Factory::NONE();
+ }
- /**
- * Sets up the fixture, e.g create a new entityManager for each test run
- * This method is called before each test method is executed.
- */
- protected function setUp() {
- parent::setUp();
- $this->eMan = $this->createEntityManager();
- }
- /**
- * Run after each test function to prevent pile-up of database connections.
- */
- protected function tearDown()
- {
- parent::tearDown();
- if (!is_null($this->eMan)) {
- $this->eMan->getConnection()->close();
- }
- }
- /**
- * @todo Still need to setup connection to different databases.
- * @return EntityManager
- */
- private function createEntityManager(){
- // Initialise to avoid unused variable warnings
- $entityManager = NULL;
- require __DIR__ . '/../../../doctrine/bootstrap_doctrine.php';
- return $entityManager;
- }
+ /**
+ * Sets up the fixture, e.g create a new entityManager for each test run
+ * This method is called before each test method is executed.
+ */
+ protected function setUp()
+ {
+ parent::setUp();
+ $this->em = $this->createEntityManager();
+ /**
+ * It would be nce to put the database setup here but it creates a rats nest of
+ * problems with cleaning the database between tests.
+ * ref: https://github.com/sebastianbergmann/dbunit/issues/37
+ */
+ }
+ /**
+ * Run after each test function to prevent pile-up of database connections.
+ */
+ protected function tearDown()
+ {
+ parent::tearDown();
+ if (!is_null($this->em)) {
+ $this->em->getConnection()->close();
+ }
+ }
+ /**
+ * @todo Still need to setup connection to different databases.
+ * @return EntityManager
+ */
+ private function createEntityManager()
+ {
+ // Initialise to avoid unused variable warnings
+ $entityManager = null;
+ require __DIR__ . '/../../../doctrine/bootstrap_doctrine.php';
+ return $entityManager;
+ }
- /**
- * Called after setUp() and before each test. Used for common assertions
- * across all tests.
- */
- protected function assertPreConditions() {
- $con = $this->getConnection();
- $fixture = __DIR__ . '/../../../doctrine/truncateDataTables.xml';
- $tables = simplexml_load_file($fixture);
+ /**
+ * Called after setUp() and before each test. Used for common assertions
+ * across all tests.
+ */
+ protected function assertPreConditions()
+ {
+ /**
+ * Checks that all tables are empty before we start a test.
+ */
+ $con = $this->getConnection();
+ $fixture = __DIR__ . '/../../../doctrine/truncateDataTables.xml';
+ $tables = simplexml_load_file($fixture);
+
+ foreach ($tables as $tableName) {
+ $sql = "SELECT * FROM " . $tableName->getName();
+ $result = $con->createQueryTable('results_table', $sql);
+ if ($result->getRowCount() != 0) {
+ throw new RuntimeException("Invalid fixture. Table has rows: " . $tableName->getName());
+ }
+ }
+ }
+ private function createTestData()
+ {
+
+ //$project1 = new \Project("project1");
+ //$this->em->persist($project1);
+ //$ngi1 = TestUtil::createSampleNGI("ngi1");
+ //$this->em->persist($ngi1);
+
+ $pKey = new \PrimaryKey();
+ $this->em->persist($pKey);
+
+ $this->em->flush();
+
+ $site1 = TestUtil::createSampleSite("site1");
+ $this->em->persist($site1);
+ $site1->setPrimaryKey($pKey->getId());
+
+ $service1 = TestUtil::createSampleService("service1");
+ $this->em->persist($service1);
+
+ $type1 = TestUtil::createSampleServiceType("sample service type", "servicetype1");
+ $this->em->persist($type1);
+
+ $user1 = TestUtil::createSampleUser("forename1", "surname1", "/cn=dummy1");
+ $this->em->persist($user1);
+ $user1->setAdmin(true);
+
+ $scope1 = TestUtil::createSampleScope("sample scope1", "scope1");
+ $this->em->persist($scope1);
+
+ //$service1->setParentSiteDoJoin($site1);
+ //$ngi1->addSiteDoJoin($site1);
+ //$project1->addNgi($ngi1);
+
+ $this->em->flush();
+
+ // This seems to be the minimal newvalues array to allow the
+ // editService to execute
+ $serviceValues = array(
+ "hostingSite" => $site1->getId(),
+ "serviceType" => $type1->getId(),
+ "PRODUCTION_LEVEL" => "Y",
+ "IS_MONITORED" => "Y",
+ "BETA" => false,
+ "Scope_ids" => array($scope1),
+ "ReservedScope_ids" => array(),
+ "SE" => array(
+ "HOSTNAME" => "gocdb.somedomain.biz",
+ "URL" => "https://gocdb.somedomain.biz",
+ "DESCRIPTION" => "some text to describe something",
+ "HOST_DN" => "/C=UK/O=HR/CN=me.me.me",
+ "HOST_IP" => "0.0.0.0",
+ "HOST_IP_V6" => "0000:0000:0000:0000:0000:0000:0000:0000",
+ "HOST_OS" => "BSD",
+ "HOST_ARCH" => "x86_64",
+ "EMAIL" => "pooh.bear@gocdb.org"
+ )
+ );
+
+ $servService = new ServiceService();
+ $servService->setEntityManager($this->em);
+
+ $roleAMS = new RoleActionMappingService();
+
+ $roleAAS = new RoleActionAuthorisationService($roleAMS);
+ $roleAAS->setEntityManager($this->em);
+
+ $servService->setRoleActionAuthorisationService($roleAAS);
+
+ $scopeService = new ScopeService();
+ $scopeService->setEntityManager($this->em);
+
+ $servService->setScopeService($scopeService);
+
+ return array ($servService, $serviceValues, $user1, $type1);
+ }
+
+ /**
+ * Check that basic add service works
+ */
+ public function testAddService()
+ {
+
+ print __METHOD__ . "\n";
+
+ list ($servService, $serviceValues, $user, ) = $this->createTestData();
+
+ // Check we get a service back.
+ $this->assertInstanceOf(
+ '\Service',
+ $service = $servService->addService($serviceValues, $user)
+ );
+
+ $this->assertTrue($service->getProduction());
+ $this->assertTrue($service->getMonitored());
+ }
+ /**
+ * Check the default rule that production services must be monitored.
+ * @depends testAddService
+ */
+ public function testMonitoringFlag1()
+ {
+
+ print __METHOD__ . "\n";
+
+ list ($servService, $serviceValues, $user, ) = $this->createTestData();
+
+ // Force Monitoring and Production in conflict: should fail.
+ $serviceValues["PRODUCTION_LEVEL"] = "Y";
+ $serviceValues["IS_MONITORED"] = "N";
+
+ $this->setExpectedException('Exception');
+ $this->assertInstanceOf(
+ '\Service',
+ $servService->addService($serviceValues, $user)
+ );
+ }
+ /**
+ * Check that exceptions to the default rule that production services
+ * must be monitored are handled correctly
+ * @depends testMonitoringFlag1
+ */
+ public function testMonitoringFlag2()
+ {
+
+ print __METHOD__ . "\n";
+
+ list ($servService, $serviceValues, $user, $type) = $this->createTestData();
+
+ // Force Monitoring and Production in conflict: should fail but ...
+ $serviceValues["PRODUCTION_LEVEL"] = "Y";
+ $serviceValues["IS_MONITORED"] = "N";
+
+ // ... set the exception so it doesn't.
+ $type->setAllowMonitoringException(1);
+
+ $this->assertInstanceOf(
+ '\Service',
+ $service = $servService->addService($serviceValues, $user)
+ );
- foreach($tables as $tableName) {
- $sql = "SELECT * FROM ".$tableName->getName();
- $result = $con->createQueryTable('results_table', $sql);
- if($result->getRowCount() != 0){
- throw new RuntimeException("Invalid fixture. Table has rows: ".$tableName->getName());
- }
+ $this->assertTrue($service->getProduction());
+ $this->assertFalse($service->getMonitored());
}
- }
+ /**
+ * Check that exceptions to the default rule that production services
+ * must be monitored are handled correctly
+ * @depends testAddService
+ */
+ public function testEditService()
+ {
- public function createValidationEntities(){
+ print __METHOD__ . "\n";
- $util = new TestUtil();
+ list ($servService, $serviceValues, $user, ) = $this->createTestData();
- $site = $util->createSampleSite("TestSite");
- $this->eMan->persist($site);
+ // Get a service
+ $service = $servService->addService($serviceValues, $user);
- $service = $util->createSampleService("TestService1");
- $this->eMan->persist($service);
- $service->setParentSiteDoJoin($site);
+ // Make some rather arbitrary changes not in conflict
+ $serviceValues["PRODUCTION_LEVEL"] = "N";
+ $serviceValues["IS_MONITORED"] = "N";
- $user = $util->createSampleUser("Test", "Testing");
- $identifier= TestUtil::createSampleUserIdentifier("X.509", "/c=test");
- $user->addUserIdentifierDoJoin($identifier);
- $this->eMan->persist($identifier);
- $this->eMan->persist($user);
- $user->setAdmin(TRUE);
+ $this->assertInstanceOf(
+ '\Service',
+ $newS = $servService->editService($service, $serviceValues, $user)
+ );
- $roleAMS = new org\gocdb\services\RoleActionMappingService();
- $roleAAS = new org\gocdb\services\RoleActionAuthorisationService($roleAMS);
- $roleAAS->setEntityManager($this->eMan);
+ $this->assertFalse($newS->getProduction());
+ $this->assertFalse($newS->getMonitored());
+ }
+ /**
+ * Check that exceptions to the default rule that production services
+ * must be monitored are handled correctly
+ * @depends testEditService
+ */
+ public function testMonitoringFlag3()
+ {
+
+ print __METHOD__ . "\n";
+
+ list ($servService, $serviceValues, $user, ) = $this->createTestData();
- $this->eMan->flush();
+ // Get a service
+ $service = $servService->addService($serviceValues, $user);
- $serviceService = new org\gocdb\services\ServiceService();
- $serviceService->setEntityManager($this->eMan);
- $serviceService->setRoleActionAuthorisationService($roleAAS);
+ // Force Monitoring and Production in conflict: should fail.
+ $serviceValues["PRODUCTION_LEVEL"] = "Y";
+ $serviceValues["IS_MONITORED"] = "N";
+
+ $this->setExpectedException('Exception');
+ $this->assertInstanceOf(
+ '\Service',
+ $servService->editService($service, $serviceValues, $user)
+ );
+ }
+ /**
+ * Check that exceptions to the default rule that production services
+ * must be monitored are handled correctly
+ * @depends testMonitoringFlag3
+ */
+ public function testMonitoringFlag4()
+ {
- return array($service, $user, $serviceService);
- }
+ print __METHOD__ . "\n";
+
+ list ($servService, $serviceValues, $user, $type) = $this->createTestData();
+
+ // Get a service
+ $service = $servService->addService($serviceValues, $user);
+
+ // Force Monitoring and Production in conflict: should fail but ...
+ $serviceValues["PRODUCTION_LEVEL"] = "Y";
+ $serviceValues["IS_MONITORED"] = "N";
+
+ // ... set the exception so it doesn't.
+ $type->setAllowMonitoringException(1);
+
+ $this->assertInstanceOf(
+ '\Service',
+ $newS = $servService->editService($service, $serviceValues, $user)
+ );
+
+ $this->assertTrue($newS->getProduction());
+ $this->assertFalse($newS->getMonitored());
+ }
+ public function createValidationEntities()
+ {
+
+ $util = new TestUtil();
+
+ $site = $util->createSampleSite("TestSite");
+ $this->em->persist($site);
+
+ $service = $util->createSampleService("TestService1");
+ $this->em->persist($service);
+ $service->setParentSiteDoJoin($site);
+
+ $user = $util->createSampleUser("Test", "Testing");
+ $identifier = TestUtil::createSampleUserIdentifier("X.509", "/c=test");
+ $user->addUserIdentifierDoJoin($identifier);
+ $this->em->persist($identifier);
+ $this->em->persist($user);
+ $user->setAdmin(true);
+
+ $roleAMS = new RoleActionMappingService();
+ $roleAAS = new RoleActionAuthorisationService($roleAMS);
+ $roleAAS->setEntityManager($this->em);
+
+ $this->em->flush();
+
+ $serviceService = new ServiceService();
+ $serviceService->setEntityManager($this->em);
+ $serviceService->setRoleActionAuthorisationService($roleAAS);
+
+ return array($service, $user, $serviceService);
+ }
/**
* Check the basics -
* Duplicates some simple testing from ExtensionsTest
*/
- public function testValidateProperty(){
- print __METHOD__ . "\n";
+ public function testValidateProperty()
+ {
+ print __METHOD__ . "\n";
- list ($service, $user, $serviceService) = $this->createValidationEntities();
- // Properties are specified as array of arrays of form
- // [[Name,Value],[Name,Value], ... ]
- $values[0] = array("ValidName1","ValidValue");
- $values[1] = array("ValidName2","");
+ list ($service, $user, $serviceService) = $this->createValidationEntities();
+ // Properties are specified as array of arrays of form
+ // [[Name,Value],[Name,Value], ... ]
+ $values = [];
+ $values[0] = array("ValidName1","ValidValue");
+ $values[1] = array("ValidName2","");
- $this->assertTrue($serviceService->addProperties($service, $user, $values) == NULL);
+ $this->assertTrue($serviceService->addProperties($service, $user, $values) == null);
- $this->assertTrue(count($properties = $service->getServiceProperties()) == 2);
+ $this->assertTrue(count($properties = $service->getServiceProperties()) == 2);
- $this->assertTrue(
- $serviceService->deleteServiceProperties($service, $user, $properties->toArray())
- == NULL);
+ $this->assertTrue(
+ $serviceService->deleteServiceProperties($service, $user, $properties->toArray())
+ == null
+ );
- $this->assertTrue(count($properties = $service->getServiceProperties()) == 0);
- }
+ $this->assertTrue(count($properties = $service->getServiceProperties()) == 0);
+ }
/**
* Check that validation of property name is operating as expected
* Added to test code changes to pass through "<>" chars
* @depends testValidateProperty
*/
- public function testValidatePropertyNameFails(){
- print __METHOD__ . "\n";
-
- list ($service, $user, $serviceService) = $this->createValidationEntities();
- // Properties are specified as array of arrays of form
- // [[Name,Value],[Name,Value], ... ]
- // < & > are invalid characters in the property name but are valid
- // for the property value.
- $values[0] = array("","");
+ public function testValidatePropertyNameFails()
+ {
+ print __METHOD__ . "\n";
- $this->setExpectedException('Exception');
+ list ($service, $user, $serviceService) = $this->createValidationEntities();
+ // Properties are specified as array of arrays of form
+ // [[Name,Value],[Name,Value], ... ]
+ // < & > are invalid characters in the property name but are valid
+ // for the property value.
+ $values = [];
+ $values[0] = array("","");
- $serviceService->addProperties($service, $user, $values);
+ $this->setExpectedException('Exception');
- }
+ $serviceService->addProperties($service, $user, $values);
+ }
/**
* Check that validation of property value is operating as expected
* @depends testValidateProperty
*/
- public function testValidatePropertyValueFails(){
- print __METHOD__ . "\n";
+ public function testValidatePropertyValueFails()
+ {
+ print __METHOD__ . "\n";
- list ($service, $user, $serviceService) = $this->createValidationEntities();
- // Properties are specified as array of arrays of form
- // [[Name,Value],[Name,Value], ... ]
- // Quote characters are invalid in property value
- $values[0] = array("Valid","'Not Valid'");
+ list ($service, $user, $serviceService) = $this->createValidationEntities();
+ // Properties are specified as array of arrays of form
+ // [[Name,Value],[Name,Value], ... ]
+ // Quote characters are invalid in property value
+ $values = [];
+ $values[0] = array("Valid","'Not Valid'");
- $this->setExpectedException('Exception');
+ $this->setExpectedException('Exception');
- $serviceService->addProperties($service, $user, $values);
-
- }
+ $serviceService->addProperties($service, $user, $values);
+ }
}
diff --git a/tests/unit/lib/Gocdb_Services/ServiceTestUtil.php b/tests/unit/lib/Gocdb_Services/ServiceTestUtil.php
index f0bdcfab5..9765e62b7 100644
--- a/tests/unit/lib/Gocdb_Services/ServiceTestUtil.php
+++ b/tests/unit/lib/Gocdb_Services/ServiceTestUtil.php
@@ -1,48 +1,59 @@
persist($instance);
- $em->flush();
- }
- /**
- * Create some test site data
- * @param EntityManager $em Entity Manager handle
- */
- public static function getSiteData ($em) {
+class ServiceTestUtil
+{
+ /**
+ * Persist and flush an entity
+ * @param \Doctrine\ORM\EntityManager $em Entity manager
+ * @param Object $instance
+ */
+ public static function persistAndFlush($em, $instance)
+ {
+ $em->persist($instance);
+ $em->flush();
+ }
+ /**
+ * Create some test site data
+ * @param EntityManager $em Entity Manager handle
+ */
+ public static function getSiteData($em)
+ {
- $infra = TestUtil::createSampleInfrastructure('Production');
- $em->persist($infra);
+ $infra = TestUtil::createSampleInfrastructure('Production');
+ $em->persist($infra);
- $ngi = TestUtil::createSampleNGI('ngi1_');
- $em->persist($ngi);
+ $ngi = TestUtil::createSampleNGI('ngi1_');
+ $em->persist($ngi);
- $scope = TestUtil::createSampleScope('scope 1', 'Scope1');
- $em->persist($scope);
+ $scope = TestUtil::createSampleScope('scope 1', 'Scope1');
+ $em->persist($scope);
- $certStatus = TestUtil::createSampleCertStatus('Certified');
- $em->persist($certStatus);
+ $certStatus = TestUtil::createSampleCertStatus('Certified');
+ $em->persist($certStatus);
- $country = TestUtil::createSampleCountry('Utopia');
- $em->persist($country);
+ $country = TestUtil::createSampleCountry('Utopia');
+ $em->persist($country);
- $em->flush();
+ $em->flush();
- $siteData = array (
- 'NGI' => $ngi->getId(),
- 'Site' => array(
+ $siteData = array (
+ 'NGI' => $ngi->getId(),
+ 'Site' => array(
'SHORT_NAME' => 's1',
'DESCRIPTION' => 'A test site',
'OFFICIAL_NAME' => 'An-official-site',
@@ -62,67 +73,98 @@ public static function getSiteData ($em) {
'EMERGENCYEMAIL' => 'anon@localhost.net',
'HELPDESKEMAIL' => 'anon@localhost.net',
'TIMEZONE' => 'GMT'),
- 'Scope_ids' => array($scope->getId()),
- 'ReservedScope_ids' => array(),
- 'ProductionStatus' => $infra->getId(),
- 'Certification_Status' => $certStatus->getId(),
- 'Country' => $country->getId()
- );
-
- return $siteData;
- }
+ 'Scope_ids' => array($scope->getId()),
+ 'ReservedScope_ids' => array(),
+ 'ProductionStatus' => $infra->getId(),
+ 'Certification_Status' => $certStatus->getId(),
+ 'Country' => $country->getId()
+ );
+
+ return $siteData;
+ }
/**
* Create and return a minimal Site Service instance
* @param \Doctrine\ORM\EntityManager EntityManager $em
* @param array $siteData Minimal initial site data array
* @return \Site $site
*/
- public static function createAndAddSite ($em, $siteData) {
+ public function createAndAddSite($em, $siteData)
+ {
- $user = TestUtil::createSampleUser('Alpha','User');
+ $user = TestUtil::createSampleUser('Alpha', 'User');
// We don't want to test all the roleAction logic here so simply make us an admin
- $user->setAdmin(true);
+ $user->setAdmin(true);
- $identifier = TestUtil::createSampleUserIdentifier('X.509', '/Alpha.User');
- ServiceTestUtil::persistAndFlush($em, $identifier);
+ $identifier = TestUtil::createSampleUserIdentifier('X.509', '/Alpha.User');
+ $this->persistAndFlush($em, $identifier);
- $user->addUserIdentifierDoJoin($identifier);
+ $user->addUserIdentifierDoJoin($identifier);
- ServiceTestUtil::persistAndFlush($em, $user);
+ $this->persistAndFlush($em, $user);
- $siteService = ServiceTestUtil::getSiteService($em);
+ $siteService = $this->getSiteService($em);
- $site = $siteService->addSite($siteData, $user);
+ $site = $siteService->addSite($siteData, $user);
- return $site;
- }
+ return $site;
+ }
/**
* Generate minimal Site Service
- * @param \Doctrine\ORM\EntityManager EntityManager $em
- * @return org\gocdb\services\Site $siteService
+ * @param EntityManager EntityManager $em
+ * @return Site $siteService
*/
- public static function getSiteService ($em) {
- $siteService = new org\gocdb\services\Site();
- $siteService->setEntityManager($em);
+ public function getSiteService($em)
+ {
+ $siteService = new Site();
+ $siteService->setEntityManager($em);
// Need stubs for both role and scope services
- $roleAAS = TestUtil::createSampleRoleAAS(__DIR__ .
+ $roleAAS = TestUtil::createSampleRoleAAS(__DIR__ .
"/../../resources/roleActionMappingSamples/TestRoleActionMappings5.xml");
- $roleAAS->setEntityManager($em);
- $siteService->setRoleActionAuthorisationService($roleAAS);
- $siteService->setScopeService(ServiceTestUtil::getScopeService($em));
+ $roleAAS->setEntityManager($em);
+ $siteService->setRoleActionAuthorisationService($roleAAS);
+ $siteService->setScopeService($this->getScopeService($em));
- return $siteService;
- }
+ return $siteService;
+ }
/**
* Generate a useless minimal Scope Service
* NB. Should be done in the siteService constructor (?)
*/
- private static function getScopeService($em) {
- $scopeService = new \org\gocdb\services\Scope();
- $scopeService->setEntityManager($em);
+ private static function getScopeService($em)
+ {
+ $scopeService = new Scope();
+ $scopeService->setEntityManager($em);
+
+ return $scopeService;
+ }
+ public function createGocdbEntities($entityManager)
+ {
+ /**
+ * Set up the site, user and service objects shared by
+ * some tests.
+ *
+ * @return array Created User, Site and SiteService instances
+ */
+
+ $siteData = $this->getSiteData($entityManager);
+ $siteService = $this->getSiteService($entityManager);
+ $site = $this->createAndAddSite($entityManager, $siteData);
+
+ $user = TestUtil::createSampleUser('Beta', 'User');
+ $user->setAdmin(true);
+
+ $identifier = TestUtil::createSampleUserIdentifier('X.509', '/Beta.User');
+ $this->persistAndFlush($entityManager, $identifier);
+
+ $user->addUserIdentifierDoJoin($identifier);
+
+ $this->persistAndFlush($entityManager, $user);
+
+ $authEntServ = new APIAuthenticationService();
+ $authEntServ->setEntityManager($entityManager);
- return $scopeService;
- }
+ return [$user, $site, $siteService, $authEntServ];
+ }
}
diff --git a/tests/unit/lib/Gocdb_Services/ServiceTypeServiceTest.php b/tests/unit/lib/Gocdb_Services/ServiceTypeServiceTest.php
new file mode 100644
index 000000000..8f7c9fa4f
--- /dev/null
+++ b/tests/unit/lib/Gocdb_Services/ServiceTypeServiceTest.php
@@ -0,0 +1,252 @@
+createFlatXMLDataSet(__DIR__ . '/../../../doctrine/truncateDataTables.xml');
+ }
+
+ /**
+ * Overridden.
+ */
+ protected function getSetUpOperation()
+ {
+ // CLEAN_INSERT is default
+ //return PHPUnit_Extensions_Database_Operation_Factory::CLEAN_INSERT();
+ //return PHPUnit_Extensions_Database_Operation_Factory::UPDATE();
+ //return PHPUnit_Extensions_Database_Operation_Factory::NONE();
+ //
+ // Issue a DELETE from which is more portable than a
+ // TRUNCATE table (some DBs require high privileges for truncate statements
+ // and also do not allow truncates across tables with FK contstraints e.g. Oracle)
+ return PHPUnit_Extensions_Database_Operation_Factory::DELETE_ALL();
+ }
+
+ /**
+ * Overridden.
+ */
+ protected function getTearDownOperation()
+ {
+ // NONE is default
+ return PHPUnit_Extensions_Database_Operation_Factory::NONE();
+ }
+
+ /**
+ * Sets up the fixture, e.g create a new entityManager for each test run
+ * This method is called before each test method is executed.
+ */
+ protected function setUp()
+ {
+ parent::setUp();
+ $this->em = $this->createEntityManager();
+ /**
+ * It would be nce to put the database setup here but it creates a rats nest of
+ * problems with cleaning the database between tests.
+ * ref: https://github.com/sebastianbergmann/dbunit/issues/37
+ */
+ }
+
+ /**
+ * @todo Still need to setup connection to different databases.
+ * @return EntityManager
+ */
+ private function createEntityManager()
+ {
+ $entityManager = null;
+ require __DIR__ . '/../../../doctrine/bootstrap_doctrine.php';
+ return $entityManager;
+ }
+
+ /**
+ * Called after setUp() and before each test. Used for common assertions
+ * across all tests.
+ */
+ protected function assertPreConditions()
+ {
+ /**
+ * Checks that all tables are empty before we start a test.
+ */
+ $con = $this->getConnection();
+ $fixture = __DIR__ . '/../../../doctrine/truncateDataTables.xml';
+ $tables = simplexml_load_file($fixture);
+
+ foreach ($tables as $tableName) {
+ //print $tableName->getName() . "\n";
+ $sql = "SELECT * FROM " . $tableName->getName();
+ $result = $con->createQueryTable('results_table', $sql);
+ //echo 'row count: '.$result->getRowCount() ;
+ if ($result->getRowCount() != 0) {
+ throw new RuntimeException("Invalid fixture. Table has rows: " . $tableName->getName());
+ }
+ }
+ }
+ private function createTestData()
+ {
+
+ //$project1 = new \Project("project1");
+ //$this->em->persist($project1);
+ //$ngi1 = TestUtil::createSampleNGI("ngi1");
+ //$this->em->persist($ngi1);
+
+ $pKey = new \PrimaryKey();
+ $this->em->persist($pKey);
+
+ $this->em->flush();
+
+ $user1 = TestUtil::createSampleUser("forename1", "surname1", "/cn=dummy1");
+ $this->em->persist($user1);
+ $user1->setAdmin(true);
+
+ $this->em->flush();
+
+ $values = array (
+ "Name" => "serviceType1",
+ "Description" => "description of service type 1",
+ "AllowMonitoringException" => false );
+
+ return array ($values, $user1);
+ }
+
+ /**
+ * Check that basic add service works and monitoring is not allowed
+ * for production services.
+ */
+ public function testAddServiceType1()
+ {
+
+ print __METHOD__ . "\n";
+
+ list ($values, $user) = $this->createTestData();
+
+ $this->assertInstanceOf(
+ 'org\gocdb\services\ServiceType',
+ $sTypeServ = new ServiceTypeService()
+ );
+
+ $sTypeServ->setEntityManager($this->em);
+
+ // Check we get a service type back.
+ $this->assertInstanceOf(
+ '\ServiceType',
+ $sType = $sTypeServ->addServiceType($values, $user)
+ );
+
+ $this->assertFalse($sType->getAllowMonitoringException());
+ }
+ /**
+ * Check that duplicates fail
+ * @depends testAddServiceType1
+ */
+ public function testAddServiceType2()
+ {
+
+ print __METHOD__ . "\n";
+
+ list ($values, $user) = $this->createTestData();
+
+ $sTypeServ = new ServiceTypeService();
+
+ $sTypeServ->setEntityManager($this->em);
+ $sTypeServ->addServiceType($values, $user);
+
+ // Finally - trying to add the same again should fail
+ $this->setExpectedException('Exception');
+ $sTypeServ->addServiceType($values, $user);
+ }
+ /**
+ * Check that admin privileges are needed
+ * @depends testAddServiceType1
+ */
+ public function testAddServiceType3()
+ {
+
+ print __METHOD__ . "\n";
+
+ list ($values, $user) = $this->createTestData();
+
+ $user->setAdmin(false);
+
+ $sTypeServ = new ServiceTypeService();
+
+ $sTypeServ->setEntityManager($this->em);
+
+ $this->setExpectedException('Exception');
+ $sTypeServ->addServiceType($values, $user);
+ }
+ /**
+ * Check that admin privileges are needed
+ * @depends testAddServiceType1
+ */
+ public function testEditServiceType1()
+ {
+ print __METHOD__ . "\n";
+
+ list ($values, $user) = $this->createTestData();
+
+ $sTypeServ = new ServiceTypeService();
+
+ $sTypeServ->setEntityManager($this->em);
+
+ $sType = $sTypeServ->addServiceType($values, $user);
+
+ // Change the name and check the edit succeeds
+ $newName = $values['Name'] . '0';
+ $values['Name'] = $newName;
+
+ $sTypeServ->editServiceType($sType, $values, $user);
+
+ $this->assertEquals($newName, $sType->getName());
+ }
+}
diff --git a/tests/unit/lib/Gocdb_Services/SiteServiceTest.php b/tests/unit/lib/Gocdb_Services/SiteServiceTest.php
index 85bf39ed5..f71b445b7 100644
--- a/tests/unit/lib/Gocdb_Services/SiteServiceTest.php
+++ b/tests/unit/lib/Gocdb_Services/SiteServiceTest.php
@@ -12,6 +12,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
+namespace org\gocdb\tests;
+
require_once __DIR__ . '/../../../doctrine/TestUtil.php';
require_once __DIR__ . '/ServiceTestUtil.php';
require_once __DIR__ . '/../../../../lib/Doctrine/entities/User.php';
@@ -21,25 +24,32 @@
require_once __DIR__ . '/../../../../lib/Gocdb_Services/Scope.php';
use Doctrine\ORM\EntityManager;
+use org\gocdb\tests\ServiceTestUtil;
+use PHPUnit_Extensions_Database_Operation_Factory;
+use PHPUnit_Extensions_Database_TestCase;
+use RuntimeException;
+use TestUtil;
/**
* DBUnit test class for the {@see \org\gocdb\services\Site} service.
*
* @author Ian Neilson (after David Meredith)
*/
-class siteServiceTest extends PHPUnit_Extensions_Database_TestCase
+class SiteServiceTest extends PHPUnit_Extensions_Database_TestCase
{
private $entityManager;
private $dbOpsFactory;
/** @var TestUtil $testUtil */
private $testUtil;
+ private $serviceTestUtil;
- function __construct()
+ public function __construct()
{
parent::__construct();
// Use a local instance to avoid Mess Detector's whinging about avoiding
// static access.
$this->dbOpsFactory = new PHPUnit_Extensions_Database_Operation_Factory();
+ $this->serviceTestUtil = new ServiceTestUtil();
}
/**
* Overridden.
@@ -167,16 +177,16 @@ public function testAddSite()
{
print __METHOD__ . "\n";
- $siteData = ServiceTestUtil::getSiteData($this->entityManager);
- $siteService = ServiceTestUtil::getSiteService($this->entityManager);
+ $siteData = $this->serviceTestUtil->getSiteData($this->entityManager);
+ $siteService = $this->serviceTestUtil->getSiteService($this->entityManager);
// The most basic check
$this->assertTrue(
- $siteService instanceof org\gocdb\services\Site,
+ $siteService instanceof \org\gocdb\services\Site,
'Site Service failed to create and return a Site service'
);
- ServiceTestUtil::createAndAddSite($this->entityManager, $siteData);
+ $this->serviceTestUtil->createAndAddSite($this->entityManager, $siteData);
// Check
// N.B. Although getSitesFilterByParams says all the filters are optional,
@@ -198,9 +208,9 @@ public function testAddAPIAuthentication()
$user->setAdmin(true);
$this->persistAndFlush($user);
- $siteData = ServiceTestUtil::getSiteData($this->entityManager);
- $siteService = ServiceTestUtil::getSiteService($this->entityManager);
- ServiceTestUtil::createAndAddSite($this->entityManager, $siteData);
+ $siteData = $this->serviceTestUtil->getSiteData($this->entityManager);
+ $siteService = $this->serviceTestUtil->getSiteService($this->entityManager);
+ $this->serviceTestUtil->createAndAddSite($this->entityManager, $siteData);
$sites = $siteService->getSitesFilterByParams(array('scope' => 'Scope1'));
$site = $sites[0];
diff --git a/tests/writeAPI/abstractClass.php b/tests/writeAPI/abstractClass.php
index 93a66480f..d8aef7003 100644
--- a/tests/writeAPI/abstractClass.php
+++ b/tests/writeAPI/abstractClass.php
@@ -266,7 +266,7 @@ protected function createSampleService($append = "")
{
#create a sample site and create a new sample service and join it to that site
$sampleService = TestUtil::createSampleService("Sample service" . $append);
- $sampleST = TestUtil::createSampleServiceType("sample.service.type" . $append);
+ $sampleST = TestUtil::createSampleServiceType("Service type Description", "sample.service.type" . $append);
$sampleService->setServiceType($sampleST);
$sampleSite = $this->createSampleSite($append);
$sampleSite->addServiceDoJoin($sampleService);
diff --git a/unused_resources/ParseAtlasDataRunner.php b/unused_resources/ParseAtlasDataRunner.php
index 7161da8f1..b848607a0 100644
--- a/unused_resources/ParseAtlasDataRunner.php
+++ b/unused_resources/ParseAtlasDataRunner.php
@@ -51,4 +51,3 @@
foreach($siteArray as $siteName){
echo $siteName."\n";
}
-
|