Initial Push 2

+ Completed first implementation of both Appwrite and Firebase adapters with the core Transfer class logic ready

.env.example

@@ -0,0 +1,6 @@
+APPWRITE_TEST_PROJECT=testProject
+APPWRITE_TEST_ENDPONT=http:https://localhost/v1
+APPWRITE_TEST_KEY=xxxxxxxxxxxxxxxxxx
+
+FIREBASE_TEST_PROJECT=testProject
+FIREBASE_TEST_ACCOUNT='{type: "service_account", ...}'

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Bradley Schofield
+Copyright (c) 2022 Utopia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

composer.json

@@ -23,7 +23,6 @@
  "php": ">=8.0",
  "utopia-php/cli": "^0.14.0",
  "google/apiclient": "^2.12.1",
- "kreait/firebase-php": "^7.0",
  "appwrite/appwrite": "^7.2"
  },
  "require-dev": {

phpunit.xml

@@ -10,7 +10,9 @@
  >
  <testsuites>
  <testsuite name="Application Test Suite">
- <directory>./tests/</directory>
+ <directory>./tests/Transfer/Sources</directory>
+ <directory>./tests/Transfer/Destinations</directory>
+ <directory>./tests/Transfer/Transfers</directory>
  </testsuite>
  </testsuites>
 </phpunit>

src/Transfer/Destination.php

@@ -22,6 +22,13 @@ abstract class Destination
  */
  protected $logs = [];
 
+ /**
+ * Resource Cache
+ * 
+ * @var array $resourceCache
+ */
+ protected $resourceCache = [];
+
  /**
  * Internal Adapter State
  * 
@@ -63,25 +70,35 @@ public function registerLogs(array &$logs): void {
  }
 
  /**
- * Transfer Resources between adapters
+ * Register Resource Cache
+ * 
+ * @param array &$cache
+ */
+ public function registerResourceCache(array &$cache): void {
+ $this->resourceCache = &$cache;
+ }
+
+ /**
+ * Transfer Resources to Destination from Source callback
  * 
  * @param array $resources
  * @param callable $callback
  */
  public function run(array $resources, callable $callback, Source $source): void {
  foreach ($resources as $resource) {
  if (!in_array($resource, $this->getSupportedResources())) {
+ $this->logs[Log::FATAL] = new Log("Cannot Transfer unsupported resource: '".$resource."'");
  throw new \Exception("Cannot Transfer unsupported resource: '".$resource."'");
  }
 
- $source->run($resources, function (Log $currentLog, string $resource, array &$resourceCache) {
- switch ($resource) {
+ $source->run($resources, function (Log $currentLog, string $resourceType, array $resource) use ($callback) {
+ switch ($resourceType) {
  case Transfer::RESOURCE_USERS: {
- $this->importUsers($resourceCache);
- $resourceCache = [];
+ $this->importUsers($resource);
  break;
  }
  }
+ $callback($currentLog, $resourceType, $resource);
  });
  }
  }

src/Transfer/Destinations/Appwrite.php

@@ -5,7 +5,7 @@
 use Appwrite\Client;
 use Appwrite\Services\Users;
 use Utopia\Transfer\Destination;
-use Utopia\Transfer\Hash;
+use Utopia\Transfer\Resources\Hash;
 use Utopia\Transfer\Log;
 use Utopia\Transfer\Resources\User;
 use Utopia\Transfer\Transfer;
@@ -47,19 +47,31 @@ public function getSupportedResources(): array {
 
  public function check(array $resources = []): bool
  {
- //TODO: Implement check() method.
+ $auth = new Users($this->client);
+
+ try {
+ $auth->list();
+ } catch (\Exception $e) {
+ $this->logs[Log::ERROR] = new Log($e->getMessage());
+ return false;
+ }
+
  return true;
  }
 
- public function importPasswordUser(User $user): void
+ public function importPasswordUser(User $user): array|null
  {
- $authentication = new Users($this->client);
+ $auth = new Users($this->client);
  $hash = $user->getPasswordHash();
  $result = null;
 
+ if (empty($hash->getHash()) || empty($hash->getSalt())) {
+ throw new \Exception('User password hash is empty');
+ }
+
  switch ($hash->getAlgorithm()) {
  case Hash::SCRYPT_MODIFIED: 
- $result = $authentication->createScryptModifiedUser(
+ $result = $auth->createScryptModifiedUser(
  $user->getId(),
  $user->getEmail(),
  $hash->getHash(),
@@ -70,39 +82,40 @@ public function importPasswordUser(User $user): void
  );
  break;
  case Hash::BCRYPT:
- $result = $authentication->createBcryptUser(
+ $result = $auth->createBcryptUser(
  $user->getId(),
  $user->getEmail(),
  $hash->getHash(),
  $user->getEmail()
  );
  break;
  case Hash::ARGON2:
- $result = $authentication->createArgon2User(
+ $result = $auth->createArgon2User(
  $user->getId(),
  $user->getEmail(),
  $hash->getHash(),
  $user->getEmail()
  );
  break;
- case Hash::SHA:
- $result = $authentication->createShaUser(
+ case Hash::SHA256:
+ $result = $auth->createShaUser(
  $user->getId(),
  $user->getEmail(),
  $hash->getHash(),
+ 'sha256',
  $user->getEmail()
  );
  break;
  case Hash::PHPASS:
- $result = $authentication->createPHPassUser(
+ $result = $auth->createPHPassUser(
  $user->getId(),
  $user->getEmail(),
  $hash->getHash(),
  $user->getEmail()
  );
  break;
  case Hash::SCRYPT:
- $result = $authentication->createScryptUser(
+ $result = $auth->createScryptUser(
  $user->getId(),
  $user->getEmail(),
  $hash->getHash(),
@@ -116,26 +129,30 @@ public function importPasswordUser(User $user): void
  break;
  }
 
- if (!$result) {
- throw new \Exception('Failed to import user: "'.$user->getId().'"');
- }
+ return $result;
  }
 
  public function importUsers(array $users): void
  {
+ $auth = new Users($this->client);
+
  foreach ($users as $user) {
  /** @var \Utopia\Transfer\Resources\User $user */
  try {
- switch ($user->getType()) {
- case User::AUTH_EMAIL:
- $this->importPasswordUser($user);
- break;
- default:
- $this->logs[] = new Log(Log::WARNING, 'Not copying user: "'.$user->getId().'" due to it being an account type: "'.$user->getType().'".', \time(), $user);
- //TODO: Implement other auth types, talk to Eldadfux about API's requried (Might have to resort to using Console SDK).
+ $createdUser = in_array(User::TYPE_EMAIL, $user->getTypes()) ? $this->importPasswordUser($user) : $auth->create($user->getId(), $user->getEmail(), $user->getPhone(), null, $user->getName());
+
+ if (!$createdUser) {
+ $this->logs[Log::ERROR][] = new Log('Failed to import user', \time(), $user);
+ } else {
+ // Add more data to the user
+ $auth->updateName($user->getId(), $user->getUsername());
+ $auth->updatePhone($user->getId(), $user->getPhone());
+ $auth->updateEmailVerification($user->getId(), $user->getEmailVerified());
+ $auth->updatePhoneVerification($user->getId(), $user->getPhoneVerified());
+ $auth->updateStatus($user->getId(), !$user->getDisabled());
  }
  } catch (\Exception $e) {
- $this->logs[] = new Log(Log::ERROR, $e->getMessage(), \time(), $user);
+ $this->logs[Log::ERROR][] = new Log($e->getMessage(), \time(), $user);
  }
  }
  }

src/Transfer/Log.php

@@ -6,41 +6,19 @@ class Log {
  const INFO = 'info';
  const WARNING = 'warning';
  const ERROR = 'error';
+ const FATAL = 'fatal';
  const DEBUG = 'debug';
 
- public function __construct(private string $level = Log::INFO, private string $message = '', private int $timestamp = 0, protected Resource $resource = null)
+ public function __construct(private string $message = '', private int $timestamp = 0, protected Resource|null $resource = null)
  {
  $timestamp = \time();
  }
-
- /** 
- * Get Level
- * 
- * @returns string
- */
- public function getLevel(): string
- {
- return $this->level;
- }
-
- /**
- * Set Level
- * 
- * @param string $level
- * @returns self
- */
- public function setLevel(string $level)
- {
- $this->level = $level;
- return $this;
- }
-
  /**
  * Get Message
  * 
  * @returns string
  */
- public function getMessage()
+ public function getMessage(): string
  {
  return $this->message;
  }
@@ -51,7 +29,7 @@ public function getMessage()
  * @param string $message
  * @returns self
  */
- public function setMessage(string $message)
+ public function setMessage(string $message): self
  {
  $this->message = $message;
  return $this;
@@ -60,22 +38,46 @@ public function setMessage(string $message)
  /**
  * Get Timestamp
  * 
- * @returns string
+ * @returns int
  */
- public function getTimestamp()
+ public function getTimestamp(): int
  {
  return $this->timestamp;
  }
 
  /**
  * Set Timestamp
  * 
- * @param string $timestamp
+ * @param int $timestamp
  * @returns self
  */
- public function setTimestamp(string $timestamp)
+ public function setTimestamp(int $timestamp): self
  {
  $this->timestamp = $timestamp;
  return $this;
  }
+
+ /**
+ * Get Resource
+ * 
+ * @returns Resource|null
+ */
+ public function getResource(): ?Resource
+ {
+ return $this->resource;
+ }
+
+ /**
+ * As Array
+ * 
+ * @returns array
+ */
+ public function asArray(): array
+ {
+ return [
+ 'message' => $this->message,
+ 'timestamp' => $this->timestamp,
+ 'resource' => $this->resource ? $this->resource->asArray() : null,
+ ];
+ }
 }

src/Transfer/Resource.php

@@ -34,4 +34,11 @@ public function setId(string $id): self
  $this->id = $id;
  return $this;
  }
+
+ /**
+ * As Array
+ * 
+ * @returns array
+ */
+ abstract public function asArray(): array;
 }