From da54ec855d65086aa453a482facce64bab07d8d5 Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Mon, 23 Dec 2013 12:03:54 -0800
Subject: [PATCH] CRM-14023 CRM-14015 - Add apis for admin pages

---
 api/v3/Generic/Setvalue.php         | 13 ++---
 api/v3/PrintLabel.php               | 77 +++++++++++++++++++++++++++++
 api/v3/SmsProvider.php              | 77 +++++++++++++++++++++++++++++
 api/v3/utils.php                    | 22 +++++++--
 templates/CRM/Badge/Page/Layout.tpl |  5 +-
 templates/CRM/SMS/Page/Provider.tpl |  2 +-
 6 files changed, 179 insertions(+), 17 deletions(-)
 create mode 100644 api/v3/PrintLabel.php
 create mode 100644 api/v3/SmsProvider.php

diff --git a/api/v3/Generic/Setvalue.php b/api/v3/Generic/Setvalue.php
index 471e700aca..72cd6d41eb 100644
--- a/api/v3/Generic/Setvalue.php
+++ b/api/v3/Generic/Setvalue.php
@@ -31,14 +31,13 @@ function civicrm_api3_generic_setValue($apiRequest) {
   }
 
   switch ($def['type']) {
-    case 1:
-      //int
+    case CRM_Utils_Type::T_INT:
       if (!is_numeric($value)) {
         return civicrm_api3_create_error("Param '$field' must be a number", array('error_code' => 'NaN'));
       }
 
-    case 2:
-      //string
+    case CRM_Utils_Type::T_STRING:
+    case CRM_Utils_Type::T_TEXT:
       if (!CRM_Utils_Rule::xssString($value)) {
         return civicrm_api3_create_error(ts('Illegal characters in input (potential scripting attack)'), array('error_code' => 'XSS'));
       }
@@ -47,15 +46,13 @@ function civicrm_api3_generic_setValue($apiRequest) {
     }
     break;
 
-    case 12:
-      //date
+    case CRM_Utils_Type::T_DATE:
       $value = CRM_Utils_Type::escape($value,"Date",false);
       if (!$value)
         return civicrm_api3_create_error("Param '$field' is not a date. format YYYYMMDD or YYYYMMDDHHMMSS");
       break;
 
-    case 16:
-      //boolean
+    case CRM_Utils_Type::T_BOOLEAN:
       $value = (boolean) $value;
       break;
 
diff --git a/api/v3/PrintLabel.php b/api/v3/PrintLabel.php
new file mode 100644
index 0000000000..b059eba83c
--- /dev/null
+++ b/api/v3/PrintLabel.php
@@ -0,0 +1,77 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.4                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2013                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+*/
+
+/**
+ * File for the CiviCRM APIv3 print_label functions
+ *
+ * @package CiviCRM_APIv3
+ * @subpackage API_print_label
+ *
+ */
+
+/**
+ * Save a print_label
+ *
+ * Allowed @params array keys are:
+ * {@getfields print_label_create}
+ * @example print_labelCreate.php
+ *
+ * @return array of newly created print_label property values.
+ * @access public
+ */
+function civicrm_api3_print_label_create($params) {
+  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
+
+/**
+ * Get a print_label
+ *
+ * Allowed @params array keys are:
+ * {@getfields print_label_get}
+ * @example print_labelCreate.php
+ *
+ * @return array of retrieved print_label property values.
+ * @access public
+ */
+function civicrm_api3_print_label_get($params) {
+  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
+
+/**
+ * Delete a print_label
+ *
+ * Allowed @params array keys are:
+ * {@getfields print_label_delete}
+ * @example print_labelCreate.php
+ *
+ * @return array of deleted values.
+ * @access public
+ */
+function civicrm_api3_print_label_delete($params) {
+  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
diff --git a/api/v3/SmsProvider.php b/api/v3/SmsProvider.php
new file mode 100644
index 0000000000..5336214c15
--- /dev/null
+++ b/api/v3/SmsProvider.php
@@ -0,0 +1,77 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.4                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2013                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+*/
+
+/**
+ * File for the CiviCRM APIv3 sms_provider functions
+ *
+ * @package CiviCRM_APIv3
+ * @subpackage API_sms_provider
+ *
+ */
+
+/**
+ * Save an sms_provider
+ *
+ * Allowed @params array keys are:
+ * {@getfields sms_provider_create}
+ * @example sms_providerCreate.php
+ *
+ * @return array of newly created sms_provider property values.
+ * @access public
+ */
+function civicrm_api3_sms_provider_create($params) {
+  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
+
+/**
+ * Get an sms_provider
+ *
+ * Allowed @params array keys are:
+ * {@getfields sms_provider_get}
+ * @example sms_providerCreate.php
+ *
+ * @return array of retrieved sms_provider property values.
+ * @access public
+ */
+function civicrm_api3_sms_provider_get($params) {
+  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
+
+/**
+ * Delete an sms_provider
+ *
+ * Allowed @params array keys are:
+ * {@getfields sms_provider_delete}
+ * @example sms_providerCreate.php
+ *
+ * @return array of deleted values.
+ * @access public
+ */
+function civicrm_api3_sms_provider_delete($params) {
+  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
diff --git a/api/v3/utils.php b/api/v3/utils.php
index e98ddd42a3..d69abeefdd 100644
--- a/api/v3/utils.php
+++ b/api/v3/utils.php
@@ -287,16 +287,24 @@ function _civicrm_api3_get_DAO($name) {
     $name = 'Contact';
   }
 
-  //hack to deal with incorrectly named BAO/DAO - see CRM-10859 -
-  // several of these have been removed but am not confident mailing_recipients is
-  // tests so have not tackled.
+  // hack to deal with incorrectly named BAO/DAO - see CRM-10859
+
+  // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingRecipients
+  // but am not confident mailing_recipients is tested so have not tackled.
   if ($name == 'MailingRecipients') {
-    return 'CRM_Mailing_BAO_Recipients';
+    return 'CRM_Mailing_DAO_Recipients';
   }
+  // FIXME: DAO should be renamed CRM_ACL_DAO_AclRole
   if ($name == 'AclRole') {
     return 'CRM_ACL_DAO_EntityRole';
   }
-  // correct approach for im & acl is unclear
+  // FIXME: DAO should be renamed CRM_SMS_DAO_SmsProvider
+  // But this would impact SMS extensions so need to coordinate
+  // Probably best approach is to migrate them to use the api and decouple them from core BAOs
+  if ($name == 'SmsProvider') {
+    return 'CRM_SMS_DAO_Provider';
+  }
+  // FIXME: DAO names should follow CamelCase convention
   if ($name == 'Im' || $name == 'Acl') {
     $name = strtoupper($name);
   }
@@ -311,6 +319,10 @@ function _civicrm_api3_get_DAO($name) {
  * @return mixed
  */
 function _civicrm_api3_get_BAO($name) {
+  // FIXME: DAO should be renamed CRM_Badge_DAO_BadgeLayout
+  if ($name == 'PrintLabel') {
+    return 'CRM_Badge_BAO_Layout';
+  }
   $dao = _civicrm_api3_get_DAO($name);
   if (!$dao) {
     return NULL;
diff --git a/templates/CRM/Badge/Page/Layout.tpl b/templates/CRM/Badge/Page/Layout.tpl
index 93e0af073b..c1e5648499 100644
--- a/templates/CRM/Badge/Page/Layout.tpl
+++ b/templates/CRM/Badge/Page/Layout.tpl
@@ -49,10 +49,9 @@
           </tr>
           </thead>
           {foreach from=$rows item=row}
-            <tr id="row_{$row.id}"
-                class="{cycle values="odd-row,even-row"} {$row.class} crm-badge-layout {if NOT $row.is_active} disabled{/if}">
+            <tr id="print_label-{$row.id}" class="crm-entity {cycle values="odd-row,even-row"} {$row.class} crm-badge-layout {if NOT $row.is_active} disabled{/if}">
               <td class="crm-badge-layout-title crm-editable" data-field="title">{$row.title}</td>
-              <td class="crm-badge-layout-description">{$row.description}</td>
+              <td class="crm-badge-layout-description crm-editable" data-field="description">{$row.description}</td>
               <td id="row_{$row.id}_status" class="crm-badge-layout-is_active">
                 {if $row.is_active eq 1} {ts}Yes{/ts} {else} {ts}No{/ts} {/if}
               </td>
diff --git a/templates/CRM/SMS/Page/Provider.tpl b/templates/CRM/SMS/Page/Provider.tpl
index 55472c436e..eef86ff3b1 100644
--- a/templates/CRM/SMS/Page/Provider.tpl
+++ b/templates/CRM/SMS/Page/Provider.tpl
@@ -52,7 +52,7 @@
             <th >{ts}Action{/ts}</th>
         </tr>
         {foreach from=$rows item=row}
-        <tr id="provider-{$row.id}" class="crm-entity {cycle values="odd-row,even-row"} {$row.class}{if NOT $row.is_active} disabled{/if}">
+        <tr id="sms_provider-{$row.id}" class="crm-entity {cycle values="odd-row,even-row"} {$row.class}{if NOT $row.is_active} disabled{/if}">
             <td class="crm-provider-name"><strong>{$row.name}</strong> ({$row.title})<br/>
                 {ts}API Type:{/ts} {$row.api_type}<br/>
                 {ts}API Url:{/ts} {$row.api_url}<br/>
-- 
2.25.1