fixed #173 - add new env variable COOKIE_FILE and array config variable cookieFile.

Author: lesstif

README.md

@@ -65,6 +65,7 @@ JIRA_USER="jira-username"
 JIRA_PASS="jira-password-OR-api-token"
 # to enable session cookie authorization
 # COOKIE_AUTH_ENABLED=true
+# COOKIE_FILE=storage/jira-cookie.txt
 ```
 
 **Important Note:**
@@ -90,6 +91,7 @@ $iss = new IssueService(new ArrayConfiguration(
                'jiraPassword' => 'jira-password-OR-api-token',
                // to enable session cookie authorization (with basic authorization only)
                'cookieAuthEnabled' => true,
+               'cookieFile' => storage_path('jira-cookie.txt'),
           )
    ));
 ```

src/Configuration/AbstractConfiguration.php

@@ -84,6 +84,13 @@ abstract class AbstractConfiguration implements ConfigurationInterface
      */
     protected $cookieAuthEnabled;
 
+    /**
+     * HTTP cookie file name.
+     *
+     * @var string
+     */
+    protected $cookieFile;
+
     /**
      * @return string
      */
@@ -185,4 +192,12 @@ public function getDefaultUserAgentString()
 
         return sprintf('curl/%s (%s)', $curlVersion['version'], $curlVersion['host']);
     }
+
+    /**
+     * @return string
+     */
+    public function getCookieFile()
+    {
+        return $this->cookieFile;
+    }
 }

src/Configuration/ArrayConfiguration.php

@@ -24,6 +24,7 @@ public function __construct(array $configuration)
         $this->curlOptSslVerifyPeer = false;
         $this->curlOptVerbose = false;
         $this->cookieAuthEnabled = false;
+        $this->cookieFile = 'jira-cookie.txt';
         $this->curlOptUserAgent = $this->getDefaultUserAgentString();
 
         foreach ($configuration as $key => $value) {

src/Configuration/ConfigurationInterface.php

@@ -89,4 +89,11 @@ public function getOAuthAccessToken();
      * @return bool
      */
     public function isCookieAuthorizationEnabled();
+
+    /**
+     * get HTTP cookie file name.
+     *
+     * @return mixed
+     */
+    public function getCookieFile();
 }

src/Configuration/DotEnvConfiguration.php

@@ -34,6 +34,7 @@ public function __construct($path = '.')
         $this->jiraPassword = $this->env('JIRA_PASS');
         $this->oauthAccessToken = $this->env('OAUTH_ACCESS_TOKEN');
         $this->cookieAuthEnabled = $this->env('COOKIE_AUTH_ENABLED', false);
+        $this->cookieFile = $this->env('COOKIE_FILE', 'jira-cookie.txt');
         $this->jiraLogFile = $this->env('JIRA_LOG_FILE', 'jira-rest-client.log');
         $this->jiraLogLevel = $this->env('JIRA_LOG_LEVEL', 'WARNING');
         $this->curlOptSslVerifyHost = $this->env('CURLOPT_SSL_VERIFYHOST', false);

src/JiraClient.php

@@ -54,13 +54,6 @@ class JiraClient
      */
     protected $configuration;
 
-    /**
-     * cookie file name.
-     *
-     * @var string
-     */
-    protected $cookie = 'jira-cookies.txt';
-
     /**
      * Constructor.
      *
@@ -164,12 +157,13 @@ protected function filterNullVariable($haystack)
      * @param string $context        Rest API context (ex.:issue, search, etc..)
      * @param string $post_data
      * @param string $custom_request [PUT|DELETE]
+     * @param string $cookieFile cookie file
      *
      * @throws JiraException
      *
      * @return string
      */
-    public function exec($context, $post_data = null, $custom_request = null)
+    public function exec($context, $post_data = null, $custom_request = null, $cookieFile = null)
     {
         $url = $this->createUrlByContext($context);
 
@@ -198,7 +192,7 @@ public function exec($context, $post_data = null, $custom_request = null)
             }
         }
 
-        $this->authorization($ch);
+        $this->authorization($ch, $cookieFile);
 
         curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, $this->getConfiguration()->isCurlOptSslVerifyHost());
         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $this->getConfiguration()->isCurlOptSslVerifyPeer());
@@ -434,18 +428,22 @@ protected function createUrlByContext($context)
      *
      * @param resource $ch
      */
-    protected function authorization($ch)
+    protected function authorization($ch, $cookieFile = null)
     {
         // use cookie
         if ($this->getConfiguration()->isCookieAuthorizationEnabled()) {
-            curl_setopt($ch, CURLOPT_COOKIEJAR, $this->cookie);
-            curl_setopt($ch, CURLOPT_COOKIEFILE, $this->cookie);
+            if ($cookieFile === null){
+                $cookieFile = $this->getConfiguration()->getCookieFile();
+            }
+
+            curl_setopt($ch, CURLOPT_COOKIEJAR, $cookieFile);
+            curl_setopt($ch, CURLOPT_COOKIEFILE, $cookieFile);
 
             $this->log->addDebug('Using cookie..');
         }
 
         // if cookie file not exist, using id/pwd login
-        if (!file_exists($this->cookie)) {
+        if (!file_exists($cookieFile)) {
             $username = $this->getConfiguration()->getJiraUser();
             $password = $this->getConfiguration()->getJiraPassword();
             curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
@@ -505,12 +503,13 @@ public function toHttpQueryParameter($paramArray)
      * @param $url full url
      * @param $outDir save dir
      * @param $file save filename
+     * @param $cookieFile cookie filename
      *
      * @throws JiraException
      *
      * @return bool|mixed
      */
-    public function download($url, $outDir, $file)
+    public function download($url, $outDir, $file, $cookieFile = null)
     {
         $file = fopen($outDir.DIRECTORY_SEPARATOR.$file, 'w');
 
@@ -521,7 +520,7 @@ public function download($url, $outDir, $file)
         // output to file handle
         curl_setopt($ch, CURLOPT_FILE, $file);
 
-        $this->authorization($ch);
+        $this->authorization($ch, $cookieFile);
 
         curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, $this->getConfiguration()->isCurlOptSslVerifyHost());
         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $this->getConfiguration()->isCurlOptSslVerifyPeer());
@@ -577,4 +576,17 @@ public function download($url, $outDir, $file)
 
         return $response;
     }
+
+    /**
+     * setting cookie file path.
+     *
+     * @param $cookieFile
+     * @return $this
+     */
+    public function setCookieFile($cookieFile)
+    {
+        $this->cookieFile = $cookieFile;
+
+        return $this;
+    }
 }