Merge branch 'dcblogdev:master' into master

Author: ITMobilityControl

.github/workflows/php.yml

@@ -30,7 +30,7 @@ jobs:
       run: composer install --prefer-dist --no-progress
 
     - name: Run Pint
-      run: ./vendor/bin/pint --test
+      run: ./vendor/bin/pint
 
     - name: Run test suite
       run: ./vendor/bin/pest --parallel

docs/v3/msgraph/emails.md

@@ -134,6 +134,14 @@ To view an email call **->find($id)** followed by the id of the email.
 MsGraph::emails()->find($id);
 ```
 
+Retrieve the emails using singleValueExtendedProperties.
+
+```php
+MsGraph::emails()->get([
+  '\$filter' => 'singleValueExtendedProperties/Any(ep: ep/id eq \'String {00020329-0000-0000-C000-000000000046} Name CustomProperty\' and ep/value eq \'CustomValue\')'
+]);
+```
+
 ## Send Email
 
 To send an email the format is different to normal calls. The format is to call multiple methods to set the email properties.
@@ -172,6 +180,22 @@ MsGraph::emails()
 ->send()
 ```
 
+singleValueExtendedProperties() can be used to add custom properties to the email.
+
+```php
+MsGraph::emails()
+->to(['email@domains.com'])
+->subject('the subject')
+->body('the content')
+->singleValueExtendedProperties([
+    [
+        "id" => "String {00020329-0000-0000-C000-000000000046} Name CustomProperty",
+        "value" => "CustomValue"
+    ]
+])
+->send()
+```
+
 ## Forward Email
 
 To forward to an email call **->forward()** and use **->comment()** instead of **->body()**.
@@ -205,7 +229,3 @@ To delete an email call **->delete($id)** followed by the id of the email.
 ```php
 MsGraph::emails()->delete($id);
 ```
-
-
-
-

docs/v3/msgraph/queues.md

@@ -0,0 +1,53 @@
+---
+title: Queues
+---
+
+When using `MsGraph` within jobs, commands, or other queued processes, you need to authenticate the user explicitly. Ensure the user model has `access_token` and `refresh_token` stored in the database. Use the `login` method to authenticate the user before making any API calls:
+
+```php
+MsGraph::login(User::find(1));
+MsGraph::get('me');
+```
+
+Here's an example of how to structure a job that uses `MsGraph`:
+
+```php
+<?php
+
+namespace App\Jobs;
+
+use App\Models\User;
+use Dcblogdev\MsGraph\Facades\MsGraph;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+class ExampleMsGraphJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    protected $user;
+
+    public function __construct(User $user)
+    {
+        $this->user = $user;
+    }
+
+    public function handle(): void
+    {
+        MsGraph::login($this->user);
+        $userData = MsGraph::get('me');
+        // Process $userData as needed
+    }
+}
+```
+
+Dispatch this job with a user instance:
+
+```php
+ExampleMsGraphJob::dispatch($user);
+```
+
+This approach ensures that the Microsoft Graph API calls are made with the correct user context, even in background processes.

docs/v3/nav.php

@@ -25,6 +25,10 @@
                 'name' => 'Middleware',
                 'url' => 'msgraph/middleware',
             ],
+            [
+                'name' => 'Queues',
+                'url' => 'msgraph/queues',
+            ],
             [
                 'name' => 'Login with MsGraph',
                 'url' => 'msgraph/login-with-msgraph',

src/Events/NewMicrosoft365SignInEvent.php

@@ -14,6 +14,5 @@ class NewMicrosoft365SignInEvent
 
     public function __construct(public array $token)
     {
-
     }
 }

src/MsGraph.php

@@ -28,34 +28,36 @@ class MsGraph
 {
     public function contacts(): Contacts
     {
-        return new Contacts();
+        return new Contacts;
     }
 
     public function emails(): Emails
     {
-        return new Emails();
+        return new Emails;
     }
 
     public function files(): Files
     {
-        return new Files();
+        return new Files;
     }
 
     public function sites(): Sites
     {
-        return new Sites();
+        return new Sites;
     }
 
     public function tasklists(): TaskLists
     {
-        return new TaskLists();
+        return new TaskLists;
     }
 
     public function tasks(): Tasks
     {
-        return new Tasks();
+        return new Tasks;
     }
 
+    protected static $user;
+
     protected static string $baseUrl = 'https://graph.microsoft.com/v1.0/';
 
     protected static string $userModel = '';
@@ -83,7 +85,17 @@ public static function setUserModel(string $model): static
     {
         self::$userModel = $model;
 
-        return new static();
+        return new static;
+    }
+
+    public static function login($user)
+    {
+        self::$user = $user;
+    }
+
+    public static function getUser()
+    {
+        return self::$user;
     }
 
     /**
@@ -116,7 +128,18 @@ public function connect(?string $id = null): Redirector|RedirectResponse
 
         if (request()->has('code')) {
 
-            $accessToken = $provider->getAccessToken('authorization_code', ['code' => request('code')]);
+            try {
+                $accessToken = $provider->getAccessToken('authorization_code', ['code' => request('code')]);
+            } catch (IdentityProviderException $e) {
+
+                $response = $e->getResponseBody();
+
+                $errorMessage = "{$response['error']} {$response['error_description']}\n".
+                    'Error Code: '.($response['error_codes'][0] ?? 'N/A')."\n".
+                    'More Info: '.($response['error_uri'] ?? 'N/A');
+
+                throw new Exception($errorMessage);
+            }
 
             if (auth()->check()) {
                 $this->storeToken(
@@ -171,8 +194,8 @@ public function getAccessToken(?string $id = null, bool $redirectWhenNotConnecte
         $token = $this->getTokenData($id);
         $id = $this->getUserId($id);
 
-        if ($redirectWhenNotConnected) {
-            if (! $this->isConnected()) {
+        if ($this->getUser() === null && $redirectWhenNotConnected) {
+            if (! $this->isConnected($id)) {
                 return redirect()->away(config('msgraph.redirectUri'));
             }
         }
@@ -197,7 +220,7 @@ public function getTokenData(?string $id = null): ?MsGraphToken
         return MsGraphToken::where('user_id', $id)->where('refresh_token', '<>', '')->first();
     }
 
-    public function storeToken(string $access_token, string $refresh_token, string $expires, int $id, string $email): MsGraphToken
+    public function storeToken(string $access_token, string $refresh_token, string $expires, string $id, string $email): MsGraphToken
     {
         return MsGraphToken::updateOrCreate(['user_id' => $id], [
             'user_id' => $id,
@@ -324,6 +347,10 @@ protected function isJson(string $string): bool
 
     protected function getUserId(?string $id = null): ?string
     {
+        if ($this->getUser() !== null) {
+            $id = $this->getUser()->id;
+        }
+
         if ($id === null) {
             $id = auth()->id();
         }
@@ -334,6 +361,9 @@ protected function getUserId(?string $id = null): ?string
     protected function getProvider(): GenericProvider
     {
         app()->singleton(GenericProvider::class, function () {
+
+            $codeVerifier = bin2hex(random_bytes(32));
+
             return new GenericProvider([
                 'clientId' => config('msgraph.clientId'),
                 'clientSecret' => config('msgraph.clientSecret'),
@@ -342,6 +372,10 @@ protected function getProvider(): GenericProvider
                 'urlAccessToken' => config('msgraph.urlAccessToken'),
                 'urlResourceOwnerDetails' => config('msgraph.urlResourceOwnerDetails'),
                 'scopes' => config('msgraph.scopes'),
+                'code_challenge_method' => 'S256',
+                'code_challenge' => rtrim(
+                    strtr(base64_encode(hash('sha256', $codeVerifier, true)), '+/', '-_'), '='
+                ),
             ]);
         });
 

src/MsGraphAdmin.php

@@ -170,7 +170,7 @@ protected function isJson(string $data): bool
     /**
      * @throws Exception
      */
-    protected function guzzle(string $type, string $request, array $data = []): mixed
+    protected function guzzle(string $type, string $request, ?array $data = []): mixed
     {
         try {
             $client = new Client;

src/Resources/Contacts.php

@@ -40,7 +40,7 @@ public function update(string $id, array $data): array
         return MsGraph::patch("me/contacts/$id", $data);
     }
 
-    public function delete(string $id): array
+    public function delete(string $id): string
     {
         return MsGraph::delete("me/contacts/$id");
     }

src/Resources/Emails.php

@@ -27,6 +27,8 @@ class Emails extends MsGraph
 
     private array $attachments = [];
 
+    private array $singleValueExtendedProperties = [];
+
     public function id(string $id): static
     {
         $this->id = $id;
@@ -83,6 +85,13 @@ public function attachments(array $attachments): static
         return $this;
     }
 
+    public function singleValueExtendedProperties(array $singleValueExtendedProperties): static
+    {
+        $this->singleValueExtendedProperties = $singleValueExtendedProperties;
+
+        return $this;
+    }
+
     public function top(string $top): static
     {
         $this->top = $top;
@@ -246,6 +255,7 @@ protected function prepareEmail(): array
         $cc = $this->cc;
         $bcc = $this->bcc;
         $attachments = $this->attachments;
+        $singleValueExtendedProperties = $this->singleValueExtendedProperties;
 
         $toArray = [];
         foreach ($to as $email) {
@@ -264,13 +274,29 @@ protected function prepareEmail(): array
 
         $attachmentArray = [];
         foreach ($attachments as $file) {
-            $path = pathinfo($file);
+            if (array_key_exists('name', $file) && array_key_exists('contentBytes', $file)) {
+                $attachmentArray[] = [
+                    '@odata.type' => '#microsoft.graph.fileAttachment',
+                    'name' => $file['name'],
+                    'contentBytes' => $file['contentBytes'],
+                ];
+            } else {
+                $path = pathinfo($file);
+
+                $attachmentArray[] = [
+                    '@odata.type' => '#microsoft.graph.fileAttachment',
+                    'name' => $path['basename'],
+                    'contentType' => mime_content_type($file),
+                    'contentBytes' => base64_encode(file_get_contents($file)),
+                ];
+            }
+        }
 
-            $attachmentArray[] = [
-                '@odata.type' => '#microsoft.graph.fileAttachment',
-                'name' => $path['basename'],
-                'contentType' => mime_content_type($file),
-                'contentBytes' => base64_encode(file_get_contents($file)),
+        $singleValueExtendedPropertiesarray = [];
+        foreach ($singleValueExtendedProperties as $value) {
+            $singleValueExtendedPropertiesarray[] = [
+                'id' => $value['id'],
+                'value' => $value['value'],
             ];
         }
 

src/Resources/Files.php

@@ -42,12 +42,12 @@ public function downloadFile(string $id, string $type = 'me'): object
         return redirect()->away($id['@microsoft.graph.downloadUrl']);
     }
 
-    public function deleteFile(string $id, string $type = 'me'): array
+    public function deleteFile(string $id, string $type = 'me'): string
     {
         return MsGraph::delete($type."/drive/items/$id");
     }
 
-    public function createFolder(string $name, string $path, string $type = 'me', string $behavior = 'rename'): array
+    public function createFolder(string $name, string $path = '', string $type = 'me', string $behavior = 'rename'): array
     {
         $path = $path === '' ? $type.'/drive/root/children' : $type.'/drive/root:'.$this->forceStartingSlash($path).':/children';
 
@@ -75,6 +75,7 @@ public function rename(string $name, string $id, string $type = 'me'): array
     public function upload(string $name, string $uploadPath, string $path = '', string $type = 'me', string $behavior = 'rename'): void
     {
         $uploadSession = $this->createUploadSession($name, $path, $type, $behavior);
+        dd($uploadSession);
         $uploadUrl = $uploadSession['uploadUrl'];
 
         $fragSize = 320 * 1024;