Add manual extension

wp-content/civi-extensions/civirazorpay/README.md

@@ -0,0 +1,12 @@
+# civirazorpay
+(*FIXME: In one or two paragraphs, describe what the extension does and why one would download it. *)
+
+This is an [extension for CiviCRM](https://docs.civicrm.org/sysadmin/en/latest/customize/extensions/), licensed under [AGPL-3.0](LICENSE.txt).
+
+## Getting Started
+
+(* FIXME: Where would a new user navigate to get started? What changes would they see? *)
+
+## Known Issues
+
+(* FIXME *)

wp-content/civi-extensions/civirazorpay/civirazorpay.civix.php

@@ -0,0 +1,201 @@
+<?php
+
+// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
+
+/**
+ * The ExtensionUtil class provides small stubs for accessing resources of this
+ * extension.
+ */
+class CRM_Civirazorpay_ExtensionUtil {
+  const SHORT_NAME = 'civirazorpay';
+  const LONG_NAME = 'civirazorpay';
+  const CLASS_PREFIX = 'CRM_Civirazorpay';
+
+  /**
+   * Translate a string using the extension's domain.
+   *
+   * If the extension doesn't have a specific translation
+   * for the string, fallback to the default translations.
+   *
+   * @param string $text
+   *   Canonical message text (generally en_US).
+   * @param array $params
+   * @return string
+   *   Translated text.
+   * @see ts
+   */
+  public static function ts($text, $params = []): string {
+    if (!array_key_exists('domain', $params)) {
+      $params['domain'] = [self::LONG_NAME, NULL];
+    }
+    return ts($text, $params);
+  }
+
+  /**
+   * Get the URL of a resource file (in this extension).
+   *
+   * @param string|NULL $file
+   *   Ex: NULL.
+   *   Ex: 'css/foo.css'.
+   * @return string
+   *   Ex: 'http://example.org/sites/default/ext/org.example.foo'.
+   *   Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
+   */
+  public static function url($file = NULL): string {
+    if ($file === NULL) {
+      return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
+    }
+    return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file);
+  }
+
+  /**
+   * Get the path of a resource file (in this extension).
+   *
+   * @param string|NULL $file
+   *   Ex: NULL.
+   *   Ex: 'css/foo.css'.
+   * @return string
+   *   Ex: '/var/www/example.org/sites/default/ext/org.example.foo'.
+   *   Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'.
+   */
+  public static function path($file = NULL) {
+    // return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file);
+    return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file));
+  }
+
+  /**
+   * Get the name of a class within this extension.
+   *
+   * @param string $suffix
+   *   Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'.
+   * @return string
+   *   Ex: 'CRM_Foo_Page_HelloWorld'.
+   */
+  public static function findClass($suffix) {
+    return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix);
+  }
+
+
+}
+
+use CRM_Civirazorpay_ExtensionUtil as E;
+
+/**
+ * (Delegated) Implements hook_civicrm_config().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
+ */
+function _civirazorpay_civix_civicrm_config($config = NULL) {
+  static $configured = FALSE;
+  if ($configured) {
+    return;
+  }
+  $configured = TRUE;
+
+  $extRoot = __DIR__ . DIRECTORY_SEPARATOR;
+  $include_path = $extRoot . PATH_SEPARATOR . get_include_path();
+  set_include_path($include_path);
+  // Based on <compatibility>, this does not currently require mixin/polyfill.php.
+}
+
+/**
+ * Implements hook_civicrm_install().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
+ */
+function _civirazorpay_civix_civicrm_install() {
+  _civirazorpay_civix_civicrm_config();
+  // Based on <compatibility>, this does not currently require mixin/polyfill.php.
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_enable().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
+ */
+function _civirazorpay_civix_civicrm_enable(): void {
+  _civirazorpay_civix_civicrm_config();
+  // Based on <compatibility>, this does not currently require mixin/polyfill.php.
+}
+
+/**
+ * Inserts a navigation menu item at a given place in the hierarchy.
+ *
+ * @param array $menu - menu hierarchy
+ * @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
+ *    'Mailing', or 'Administer/System Settings'
+ * @param array $item - the item to insert (parent/child attributes will be
+ *    filled for you)
+ *
+ * @return bool
+ */
+function _civirazorpay_civix_insert_navigation_menu(&$menu, $path, $item) {
+  // If we are done going down the path, insert menu
+  if (empty($path)) {
+    $menu[] = [
+      'attributes' => array_merge([
+        'label' => $item['name'] ?? NULL,
+        'active' => 1,
+      ], $item),
+    ];
+    return TRUE;
+  }
+  else {
+    // Find an recurse into the next level down
+    $found = FALSE;
+    $path = explode('/', $path);
+    $first = array_shift($path);
+    foreach ($menu as $key => &$entry) {
+      if ($entry['attributes']['name'] == $first) {
+        if (!isset($entry['child'])) {
+          $entry['child'] = [];
+        }
+        $found = _civirazorpay_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
+      }
+    }
+    return $found;
+  }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_navigationMenu().
+ */
+function _civirazorpay_civix_navigationMenu(&$nodes) {
+  if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
+    _civirazorpay_civix_fixNavigationMenu($nodes);
+  }
+}
+
+/**
+ * Given a navigation menu, generate navIDs for any items which are
+ * missing them.
+ */
+function _civirazorpay_civix_fixNavigationMenu(&$nodes) {
+  $maxNavID = 1;
+  array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
+    if ($key === 'navID') {
+      $maxNavID = max($maxNavID, $item);
+    }
+  });
+  _civirazorpay_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
+}
+
+function _civirazorpay_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
+  $origKeys = array_keys($nodes);
+  foreach ($origKeys as $origKey) {
+    if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
+      $nodes[$origKey]['attributes']['parentID'] = $parentID;
+    }
+    // If no navID, then assign navID and fix key.
+    if (!isset($nodes[$origKey]['attributes']['navID'])) {
+      $newKey = ++$maxNavID;
+      $nodes[$origKey]['attributes']['navID'] = $newKey;
+      $nodes[$newKey] = $nodes[$origKey];
+      unset($nodes[$origKey]);
+      $origKey = $newKey;
+    }
+    if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
+      _civirazorpay_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
+    }
+  }
+}

wp-content/civi-extensions/civirazorpay/civirazorpay.php

@@ -0,0 +1,32 @@
+<?php
+
+require_once 'civirazorpay.civix.php';
+
+use CRM_Civirazorpay_ExtensionUtil as E;
+
+/**
+ * Implements hook_civicrm_config().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/
+ */
+function civirazorpay_civicrm_config(&$config): void {
+  _civirazorpay_civix_civicrm_config($config);
+}
+
+/**
+ * Implements hook_civicrm_install().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
+ */
+function civirazorpay_civicrm_install(): void {
+  _civirazorpay_civix_civicrm_install();
+}
+
+/**
+ * Implements hook_civicrm_enable().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
+ */
+function civirazorpay_civicrm_enable(): void {
+  _civirazorpay_civix_civicrm_enable();
+}

wp-content/civi-extensions/civirazorpay/info.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<extension key="civirazorpay" type="module">
+  <file>civirazorpay</file>
+  <name>civirazorpay</name>
+  <description>FIXME</description>
+  <license>AGPL-3.0</license>
+  <authors>
+    <author>
+      <name>tarunnjoshi</name>
+      <email>[email protected]</email>
+      <role>Maintainer</role>
+    </author>
+  </authors>
+  <urls>
+    <url desc="Main Extension Page">https://FIXME</url>
+    <url desc="Documentation">https://FIXME</url>
+    <url desc="Support">https://FIXME</url>
+    <url desc="Licensing">https://www.gnu.org/licenses/agpl-3.0.html</url>
+  </urls>
+  <releaseDate>2024-10-29</releaseDate>
+  <version>1.0.0</version>
+  <develStage>alpha</develStage>
+  <compatibility>
+    <ver>5.77</ver>
+  </compatibility>
+  <comments>This is a new, undeveloped module</comments>
+  <classloader>
+    <psr0 prefix="CRM_" path="."/>
+    <psr4 prefix="Civi\" path="Civi"/>
+  </classloader>
+  <civix>
+    <namespace>CRM/Civirazorpay</namespace>
+    <format>24.09.1</format>
+    <angularModule>crmCivirazorpay</angularModule>
+  </civix>
+  <mixins>
+    <mixin>[email protected]</mixin>
+    <mixin>[email protected]</mixin>
+    <mixin>[email protected]</mixin>
+  </mixins>
+</extension>

wp-content/civi-extensions/civirazorpay/managed/PaymentProcessorType.mgd.php

@@ -0,0 +1,71 @@
+<?php
+/**
+
+ * - user_name_label, password_label, signature_label, subject_label - these
+ * are generally about telling the plugin what to call these when they pass
+ * them to Omnipay. They are also shown to users so some reformatting is done
+ * to turn it into lower-first-letter camel case. Take a look at the gateway
+ * file for your gateway. This is directly under src. Some provide more than
+ * one and the 'getName' function distinguishes them. The getDefaultParameters
+ * will tell you what to pass. eg if you see
+ * 'apiKey' you should enter 'user_name' => 'Api Key' (you might ? be able to
+ * get away with 'API Key' - need to check). You can provide as many or as few
+ * as you want of these and it's irrelevant which field you put them in but
+ * note that the signature field is the longest and that in future versions of
+ * CiviCRM hashing may be done on password and signature on the screen.
+ *
+ * - 'class_name' => 'Payment_OmnipayMultiProcessor', (always)
+ *
+ * - 'url_site_default' - this is ignored. But, by giving one you make it
+ * easier for people adding processors
+ *
+ * - 'billing_mode' - 1 = onsite, 4 = redirect offsite (including transparent
+ * redirects).
+ *
+ * - payment_mode - 1 = credit card, 2 = debit card, 3 = transparent redirect.
+ * In practice 3 means that billing details are gathered on-site so it may also
+ * be used with automatic redirects where address fields need to be mandatory
+ * for the signature.
+ *
+ * The record will be automatically inserted, updated, or deleted from the
+ * database as appropriate. For more details, see "hook_civicrm_managed" at:
+ * http://wiki.civicrm.org/confluence/display/CRMDOC/Hook+Reference
+ */
+return [
+  [
+    'name' => 'MyProcessor',
+    'entity' => 'payment_processor_type',
+    'params' => [
+      'version' => 3,
+      'title' => 'Razorpay',
+      'name' => 'Razorpay',
+      'description' => 'My processor',
+      // this will cause the user to be presented with a field,
+      //  when adding this processor, labelled
+      // api key which will save to civicrm_payment_processor.user_name
+      // on save
+      'user_name_label' => 'apiKey',
+      // as per user_name_label, but saves to password
+      'password_label' => 'secret',
+      // as per user_name_label, but saves to signature
+      'signature_label' => 'signature',
+      // prefix of CRM_Core is implicit so the class ie CRM_Core_Payment_MyProcessor
+      'class_name' => 'Payment_MyProcessor',
+      // Any urls you might need stored for the user to be redirect to, for example.
+      // Note it is quite common these days to hard code the urls in the processors
+      // as they are not necessarily seen as configuration. But, if you enter
+      // something here it will be the default for data entry.
+      'url_site_default' => 'https://example.com',
+      'url_api_default' => 'https://example.com',
+      // this is a deprecated concept and these docs recommend you override
+      // anything that references it. However, if you redirect the user offsite
+      // enter 4 and if not enter 1 here.
+      'billing_mode' => 4,
+      // Generally 1 for credit card & 2 for direct debit. This will ideally 
+      // become an option group at some point but also note that it's mostly
+      // or possibly only used from functions that this documentation recommends
+      // you override (eg. `getPaymentTypeLabel`)
+      'payment_type' => 1,
+    ],
+  ],
+];