Resolve "Merge dev into main"

Related to #28 (closed)

.github/ISSUE_TEMPLATE/bug_report.md

+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - PHP: [ php 5.6 ]
+ - PHP provenance: [original Debian] 
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
+

.github/FUNDING.yml

+# These are supported funding model platforms
+
+ko_fi: fusiondirectory
+liberapay: fusiondirectory
+open_collective: fusiondirectory
+community_bridge: fusiondirectory
+github: fusiondirectory

src/FusionDirectory/Rest/WebServiceCall.php

+<?php
+
+class WebServiceCall
+{
+  private $URL, $method, $token; //String
+  private $data, $authData; //Array
+  /**
+   * @var false|resource
+   */
+  private $ch;
+
+  /**
+   * @param string $URL
+   * @param string $method
+   * @param array $data
+   * @param array $authData
+   */
+  public function __construct (string $URL, string $method, array $data = [], array $authData = [])
+  {
+    $this->URL      = $URL;
+    $this->data     = $data;
+    $this->method   = $method;
+    $this->authData = $authData;
+  }
+
+  /**
+   * @param string|NULL $URL
+   * @param array|NULL $data
+   * @param string|NULL $method
+   */
+  public function setCurlSettings (string $URL = NULL, array $data = NULL, string $method = NULL)
+  {
+    $this->ch = !empty($URL) ? curl_init($URL) : curl_init($this->URL);
+
+    // Manage a trick to perform refresh on user DN
+    if (!empty($data) && array_key_exists('refreshUser', $data)) {
+      // Empty array is required to update the user dn without passing information, json_encode will transform it to {}
+      $this->data = [];
+    } else if (!empty($data)) {
+      $this->data = $data;
+    }
+
+    if (!empty($method)) {
+      $this->method = $method;
+
+      // set the curl options based on the method required.
+      switch (strtolower($this->method)) {
+        case 'patch' :
+          curl_setopt($this->ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
+          curl_setopt($this->ch, CURLOPT_POSTFIELDS, json_encode($this->data));
+          break;
+        case 'get' :
+          // No curl_setopt required
+          break;
+        case 'put':
+          curl_setopt($this->ch, CURLOPT_CUSTOMREQUEST, 'PUT');
+          curl_setopt($this->ch, CURLOPT_POSTFIELDS, json_encode($this->data));
+          break;
+        case 'delete':
+          curl_setopt($this->ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
+          break;
+        case 'post':
+          curl_setopt($this->ch, CURLOPT_POST, TRUE);
+          curl_setopt($this->ch, CURLOPT_POSTFIELDS, json_encode($this->data));
+          break;
+      }
+    }
+
+    // Handle token retrieval via basic user/pass authentication.
+
+    if (empty($this->token)) {
+      if (empty($this->authData)) {
+        $this->token = $this->getAccessToken($_ENV['WEB_LOGIN'], $_ENV['WEB_PASS']);
+      } else {
+        $this->token = $this->getAccessToken($this->authData['username'], $this->authData['password']);
+      }
+    }
+
+    // Headers for the patch curl method containing the access_token
+    $headers = [
+      "session-token: " . $this->token
+    ];
+
+    // Set up the basic and default curl options
+    curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, TRUE);
+    curl_setopt($this->ch, CURLOPT_HTTPHEADER, $headers);
+  }
+
+  /**
+   * @param string $user
+   * @param string $password
+   * @return string
+   *  Note : Simply retrieve the access token after auth from FusionDirectory webservice.
+   */
+  private function getAccessToken (string $user, string $password): string
+  {
+    // The login endpoint is waiting a json format.
+    $loginData = [
+      'user'     => $user,
+      'password' => $password
+    ];
+
+    $ch = curl_init($this->URL);
+
+    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
+    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($loginData));
+    curl_setopt($ch, CURLOPT_POST, TRUE);
+
+    $response = curl_exec($ch);
+    $this->handleCurlError($ch);
+
+    curl_close($ch);
+
+    // Token should be decoded, to remove quotes.
+    return json_decode($response);
+  }
+
+  private function handleCurlError ($ch): void
+  {
+    // String is returned on success but a boolean on error.
+    if (curl_error($ch)) {
+      $error = [
+        'Error'  => 'Error during process of authentication to FusionDirectory web-service!',
+        'Status' => curl_errno($ch),
+      ];
+      echo json_encode($error, JSON_PRETTY_PRINT);
+      exit;
+    }
+  }
+
+  /**
+   * @param string $dn
+   * Note : receive the DN of the main task and execute it, creating related sub-tasks.
+   */
+  public function activateCyclicTasks (string $dn)
+  {
+    $data = [
+      "tasks" => [
+        "fdSubTasksActivation" => "TRUE"
+      ]
+    ];
+
+    $this->setCurlSettings($_ENV['FUSION_DIRECTORY_API_URL'] . '/objects/tasks/' . $dn, $data, 'PATCH');
+    curl_exec($this->ch);
+
+    $this->handleCurlError($this->ch);
+    $response = json_decode(curl_multi_getcontent($this->ch), TRUE);
+
+    // Manage the response from current FD WebService, returned DN seems to mean success.
+    if ($response === $dn) {
+      $response = 'Task has been activated successfully';
+    }
+
+    curl_close($this->ch);
+    return $response;
+  }
+
+  /**
+   * @param string $dn
+   * @return mixed|string
+   * Note : When life cycle is triggered, supann status are updated through LDAP, FD must now trigger updates
+   */
+  public function refreshUserInfo (string $dn)
+  {
+    // Create a specific array which will be interpreted by setCurlSettings in order to change it to an empty json data.
+    $data = [
+      'refreshUser' => NULL
+    ];
+
+    $this->setCurlSettings($_ENV['FUSION_DIRECTORY_API_URL'] . '/objects/user/' . $dn, $data, 'PATCH');
+    curl_exec($this->ch);
+
+    $this->handleCurlError($this->ch);
+    $response = json_decode(curl_multi_getcontent($this->ch), TRUE);
+
+    if ($response === $dn) {
+      $response = 'User: ' . $dn . ' has been correctly refreshed.';
+    }
+
+    curl_close($this->ch);
+    return $response;
+  }
+}
+

.gitlab-ci.yml

@@ -2,6 +2,7 @@ stages:
   - lint
   - codestyle
   - tarballs
+  - trigger
 
 ## Stage lint
 
@@ -45,8 +46,7 @@ create_phpstan_rapport:
 build-tarballs:
   stage: tarballs
   only:
-    variables:
-    - $TARBALLS_TRIGGER_VERSION
+    - dev
   script:
     - mkdir ../fusiondirectory-integrator-$VERSION/
     - mv ./* ../fusiondirectory-integrator-$VERSION/
@@ -70,3 +70,19 @@ build-release:
   artifacts:
     paths:
       - ./*.tar.gz
+
+trigger-ci-debian-bullseye:
+  stage: trigger
+  only:
+    - dev
+  trigger:
+    project: debian/bullseye-fusiondirectory-integrator-dev
+    branch: "main"
+
+trigger-ci-centos-7:
+  stage: trigger
+  only:
+    - dev
+  trigger:
+    project: centos/centos7-fusiondirectory-integrator-dev
+    branch: "main"

CODE_OF_CONDUCT.md

+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <coc@fusiondirectory.org>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://www.contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://www.contributor-covenant.org
+[version]: https://www.contributor-covenant.org/version/1/4/
+