jon48 / webtrees-lib

app/Module/Sosa/Http/RequestHandlers/SosaConfigAction.php

Indentation +42 added lines, -42 removed lines

@@ -30,52 +30,52 @@
  */
 class SosaConfigAction implements RequestHandlerInterface
 {
-    /**
-     * @var UserService $user_service
-     */
-    private $user_service;
+	/**
+	 * @var UserService $user_service
+	 */
+	private $user_service;
 
-    /**
-     * Constructor for SosaConfigAction Request Handler
-     *
-     * @param UserService $user_service
-     */
-    public function __construct(UserService $user_service)
-    {
-        $this->user_service = $user_service;
-    }
+	/**
+	 * Constructor for SosaConfigAction Request Handler
+	 *
+	 * @param UserService $user_service
+	 */
+	public function __construct(UserService $user_service)
+	{
+		$this->user_service = $user_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
 
-        $params = $request->getParsedBody();
-        assert(is_array($params));
+		$params = $request->getParsedBody();
+		assert(is_array($params));
 
-        $user_id = (int) $params['sosa-userid'];
-        $root_id = $params['sosa-rootid'] ?? '';
-        $max_gen = $params['sosa-maxgen'] ?? '';
+		$user_id = (int) $params['sosa-userid'];
+		$root_id = $params['sosa-rootid'] ?? '';
+		$max_gen = $params['sosa-maxgen'] ?? '';
 
-        if (Auth::id() == $user_id || ($user_id == -1 && Auth::isManager($tree))) {
-            $user = $user_id == -1 ? new DefaultUser() : $this->user_service->find($user_id);
-            if ($user !== null && ($root_indi = Registry::individualFactory()->make($root_id, $tree)) !== null) {
-                $tree->setUserPreference($user, 'MAJ_SOSA_ROOT_ID', $root_indi->xref());
-                $tree->setUserPreference($user, 'MAJ_SOSA_MAX_GEN', $max_gen);
-                FlashMessages::addMessage(I18N::translate('The root individual has been updated.'));
-                return redirect(route(SosaConfig::class, [
-                    'tree' => $tree->name(),
-                    'compute' => 'yes',
-                    'user_id' => $user_id
-                ]));
-            }
-        }
+		if (Auth::id() == $user_id || ($user_id == -1 && Auth::isManager($tree))) {
+			$user = $user_id == -1 ? new DefaultUser() : $this->user_service->find($user_id);
+			if ($user !== null && ($root_indi = Registry::individualFactory()->make($root_id, $tree)) !== null) {
+				$tree->setUserPreference($user, 'MAJ_SOSA_ROOT_ID', $root_indi->xref());
+				$tree->setUserPreference($user, 'MAJ_SOSA_MAX_GEN', $max_gen);
+				FlashMessages::addMessage(I18N::translate('The root individual has been updated.'));
+				return redirect(route(SosaConfig::class, [
+					'tree' => $tree->name(),
+					'compute' => 'yes',
+					'user_id' => $user_id
+				]));
+			}
+		}
 
-        FlashMessages::addMessage(I18N::translate('The root individual could not be updated.'), 'danger');
-        return redirect(route(SosaConfig::class, ['tree' => $tree->name()]));
-    }
+		FlashMessages::addMessage(I18N::translate('The root individual could not be updated.'), 'danger');
+		return redirect(route(SosaConfig::class, ['tree' => $tree->name()]));
+	}
 }

app/Module/Sosa/Http/RequestHandlers/SosaConfig.php

Indentation +60 added lines, -60 removed lines

@@ -32,72 +32,72 @@
  */
 class SosaConfig implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    /**
-     * @var SosaModule|null $module
-     */
-    private $module;
+	/**
+	 * @var SosaModule|null $module
+	 */
+	private $module;
 
-    /**
-     * Constructor for SosaConfig Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(SosaModule::class)->first();
-    }
+	/**
+	 * Constructor for SosaConfig Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(SosaModule::class)->first();
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
 
-        $users_root = array();
-        if (Auth::check()) {
-            /** @var \Fisharebest\Webtrees\User $user */
-            $user = Auth::user();
-            $users_root[] = [
-                'user'      => $user,
-                'root_id'   => $tree->getUserPreference($user, 'MAJ_SOSA_ROOT_ID'),
-                'max_gen'   => $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN')
-            ];
+		$users_root = array();
+		if (Auth::check()) {
+			/** @var \Fisharebest\Webtrees\User $user */
+			$user = Auth::user();
+			$users_root[] = [
+				'user'      => $user,
+				'root_id'   => $tree->getUserPreference($user, 'MAJ_SOSA_ROOT_ID'),
+				'max_gen'   => $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN')
+			];
 
-            if (Auth::isManager($tree)) {
-                $default_user = new DefaultUser();
-                $users_root[] = [
-                    'user' => $default_user,
-                    'root_id' => $tree->getUserPreference($default_user, 'MAJ_SOSA_ROOT_ID'),
-                    'max_gen'   => $tree->getUserPreference($default_user, 'MAJ_SOSA_MAX_GEN')
-                ];
-            }
-        }
+			if (Auth::isManager($tree)) {
+				$default_user = new DefaultUser();
+				$users_root[] = [
+					'user' => $default_user,
+					'root_id' => $tree->getUserPreference($default_user, 'MAJ_SOSA_ROOT_ID'),
+					'max_gen'   => $tree->getUserPreference($default_user, 'MAJ_SOSA_MAX_GEN')
+				];
+			}
+		}
 
-        // Use the system max generations if not set
-        $max_gen_system = app(SosaRecordsService::class)->maxSystemGenerations();
-        foreach ($users_root as $key => $user_root) {
-            $users_root[$key]['max_gen'] = is_numeric($user_root['max_gen']) ?
-                (int) $user_root['max_gen'] :
-                $max_gen_system;
-        };
+		// Use the system max generations if not set
+		$max_gen_system = app(SosaRecordsService::class)->maxSystemGenerations();
+		foreach ($users_root as $key => $user_root) {
+			$users_root[$key]['max_gen'] = is_numeric($user_root['max_gen']) ?
+				(int) $user_root['max_gen'] :
+				$max_gen_system;
+		};
 
-        return $this->viewResponse($this->module->name() . '::config-page', [
-            'module_name'       =>  $this->module->name(),
-            'title'             =>  I18N::translate('Sosa Configuration'),
-            'tree'              =>  $tree,
-            'user_id'           =>  $request->getAttribute('user'),
-            'selected_user_id'  =>  (int) ($request->getQueryParams()['user_id'] ?? 0),
-            'immediate_compute' =>  ($request->getQueryParams()['compute'] ?? '') == 'yes',
-            'users_root'        =>  $users_root
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::config-page', [
+			'module_name'       =>  $this->module->name(),
+			'title'             =>  I18N::translate('Sosa Configuration'),
+			'tree'              =>  $tree,
+			'user_id'           =>  $request->getAttribute('user'),
+			'selected_user_id'  =>  (int) ($request->getQueryParams()['user_id'] ?? 0),
+			'immediate_compute' =>  ($request->getQueryParams()['compute'] ?? '') == 'yes',
+			'users_root'        =>  $users_root
+		]);
+	}
 }

app/Module/Sosa/Http/RequestHandlers/SosaComputeModal.php

Indentation +32 added lines, -32 removed lines

@@ -28,40 +28,40 @@
  */
 class SosaComputeModal implements RequestHandlerInterface
 {
-    /**
-     * @var SosaModule|null $module
-     */
-    private $module;
+	/**
+	 * @var SosaModule|null $module
+	 */
+	private $module;
 
-    /**
-     * Constructor for SosaComputeModal Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(SosaModule::class)->first();
-    }
+	/**
+	 * Constructor for SosaComputeModal Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(SosaModule::class)->first();
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            return response(view('modals/error', [
-                'title' => I18N::translate('Error'),
-                'error' => I18N::translate('The attached module could not be found.')
-            ]));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			return response(view('modals/error', [
+				'title' => I18N::translate('Error'),
+				'error' => I18N::translate('The attached module could not be found.')
+			]));
+		}
 
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
 
-        return response(view($this->module->name() . '::modals/sosa-compute', [
-            'tree'          => $tree,
-            'xref'          =>  $request->getAttribute('xref')
-        ]));
-    }
+		return response(view($this->module->name() . '::modals/sosa-compute', [
+			'tree'          => $tree,
+			'xref'          =>  $request->getAttribute('xref')
+		]));
+	}
 }

app/Module/Sosa/Http/RequestHandlers/SosaComputeAction.php

Indentation +49 added lines, -49 removed lines

@@ -31,61 +31,61 @@
  */
 class SosaComputeAction implements RequestHandlerInterface
 {
-    /**
-     * @var UserService $user_service
-     */
-    private $user_service;
+	/**
+	 * @var UserService $user_service
+	 */
+	private $user_service;
 
-    /**
-     * Constructor for SosaConfigAction Request Handler
-     *
-     * @param UserService $user_service
-     */
-    public function __construct(UserService $user_service)
-    {
-        $this->user_service = $user_service;
-    }
+	/**
+	 * Constructor for SosaConfigAction Request Handler
+	 *
+	 * @param UserService $user_service
+	 */
+	public function __construct(UserService $user_service)
+	{
+		$this->user_service = $user_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
 
-        $params = $request->getParsedBody();
-        assert(is_array($params));
+		$params = $request->getParsedBody();
+		assert(is_array($params));
 
-        $user_id = (int) ($params['user_id'] ?? Auth::id() ?? 0);
-        $partial_from = $params['partial_from'] ?? null;
+		$user_id = (int) ($params['user_id'] ?? Auth::id() ?? 0);
+		$partial_from = $params['partial_from'] ?? null;
 
-        if (($user_id == -1 && Auth::isManager($tree)) || Auth::id() == $user_id) {
-            $user = $user_id == -1 ? new DefaultUser() : $this->user_service->find($user_id);
+		if (($user_id == -1 && Auth::isManager($tree)) || Auth::id() == $user_id) {
+			$user = $user_id == -1 ? new DefaultUser() : $this->user_service->find($user_id);
 
-            /** @var SosaCalculatorService $sosa_calc_service */
-            $sosa_calc_service = app()->makeWith(SosaCalculatorService::class, [ 'tree' => $tree, 'user' => $user]);
+			/** @var SosaCalculatorService $sosa_calc_service */
+			$sosa_calc_service = app()->makeWith(SosaCalculatorService::class, [ 'tree' => $tree, 'user' => $user]);
 
-            if (
-                $partial_from !== null &&
-                ($sosa_from = Registry::individualFactory()->make($partial_from, $tree)) !== null
-            ) {
-                $res = $sosa_calc_service->computeFromIndividual($sosa_from);
-            } else {
-                $res = $sosa_calc_service->computeAll();
-            }
+			if (
+				$partial_from !== null &&
+				($sosa_from = Registry::individualFactory()->make($partial_from, $tree)) !== null
+			) {
+				$res = $sosa_calc_service->computeFromIndividual($sosa_from);
+			} else {
+				$res = $sosa_calc_service->computeAll();
+			}
 
-            return $res ?
-                response('', 200) :
-                response(
-                    I18N::translate('An error occurred while computing Sosa ancestors.'),
-                    StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR
-                );
-        }
-        return response(
-            I18N::translate('You do not have permission to modify the user.'),
-            StatusCodeInterface::STATUS_FORBIDDEN
-        );
-    }
+			return $res ?
+				response('', 200) :
+				response(
+					I18N::translate('An error occurred while computing Sosa ancestors.'),
+					StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR
+				);
+		}
+		return response(
+			I18N::translate('You do not have permission to modify the user.'),
+			StatusCodeInterface::STATUS_FORBIDDEN
+		);
+	}
 }

app/Module/Sosa/Schema/Migration1.php

Indentation +8 added lines, -8 removed lines

@@ -22,12 +22,12 @@
 class Migration1 implements MigrationInterface
 {
     
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        // These migrations have been merged into migration 2.
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		// These migrations have been merged into migration 2.
+	}
 }

app/Module/Sosa/Schema/Migration2.php

Indentation +32 added lines, -32 removed lines

@@ -24,36 +24,36 @@
 class Migration2 implements MigrationInterface
 {
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-
-        // Clean up previous sosa table if it exists
-        DB::schema()->dropIfExists('maj_sosa');
-
-        DB::schema()->create('maj_sosa', static function (Blueprint $table): void {
-
-            $table->integer('majs_gedcom_id');
-            $table->integer('majs_user_id')->default(-1);
-            $table->bigInteger('majs_sosa')->unsigned(); // Allow to calculate sosa on 64 generations
-            $table->string('majs_i_id', 20);
-            $table->tinyInteger('majs_gen')->nullable();
-            $table->smallInteger('majs_birth_year')->nullable();
-            $table->smallInteger('majs_birth_year_est')->nullable();
-            $table->smallInteger('majs_death_year')->nullable();
-            $table->smallInteger('majs_death_year_est')->nullable();
-
-            $table->primary(['majs_gedcom_id', 'majs_user_id', 'majs_sosa']);
-
-            $table->index(['majs_gedcom_id', 'majs_user_id']);
-            $table->index(['majs_gedcom_id', 'majs_user_id', 'majs_i_id']);
-            $table->index(['majs_gedcom_id', 'majs_user_id', 'majs_gen']);
-
-            $table->foreign('majs_gedcom_id')->references('gedcom_id')->on('gedcom')->onDelete('cascade');
-            $table->foreign('majs_user_id')->references('user_id')->on('user')->onDelete('cascade');
-        });
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+
+		// Clean up previous sosa table if it exists
+		DB::schema()->dropIfExists('maj_sosa');
+
+		DB::schema()->create('maj_sosa', static function (Blueprint $table): void {
+
+			$table->integer('majs_gedcom_id');
+			$table->integer('majs_user_id')->default(-1);
+			$table->bigInteger('majs_sosa')->unsigned(); // Allow to calculate sosa on 64 generations
+			$table->string('majs_i_id', 20);
+			$table->tinyInteger('majs_gen')->nullable();
+			$table->smallInteger('majs_birth_year')->nullable();
+			$table->smallInteger('majs_birth_year_est')->nullable();
+			$table->smallInteger('majs_death_year')->nullable();
+			$table->smallInteger('majs_death_year_est')->nullable();
+
+			$table->primary(['majs_gedcom_id', 'majs_user_id', 'majs_sosa']);
+
+			$table->index(['majs_gedcom_id', 'majs_user_id']);
+			$table->index(['majs_gedcom_id', 'majs_user_id', 'majs_i_id']);
+			$table->index(['majs_gedcom_id', 'majs_user_id', 'majs_gen']);
+
+			$table->foreign('majs_gedcom_id')->references('gedcom_id')->on('gedcom')->onDelete('cascade');
+			$table->foreign('majs_user_id')->references('user_id')->on('user')->onDelete('cascade');
+		});
+	}
 }

app/Module/Sosa/Schema/Migration0.php

Indentation +8 added lines, -8 removed lines

@@ -22,12 +22,12 @@
 class Migration0 implements MigrationInterface
 {
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        // These migrations have been merged into migration 2.
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		// These migrations have been merged into migration 2.
+	}
 }

app/Module/Sosa/Services/SosaCalculatorService.php

Indentation +139 added lines, -139 removed lines

@@ -24,143 +24,143 @@
  */
 class SosaCalculatorService
 {
-    /**
-     * Maximium size for the temporary Sosa table
-     * @var int TMP_SOSA_TABLE_LIMIT
-     */
-    private const TMP_SOSA_TABLE_LIMIT = 1000;
-
-    /**
-     * @var SosaRecordsService $sosa_records_service
-     */
-    private $sosa_records_service;
-
-    /**
-     * Reference user
-     * @var UserInterface $user
-     */
-    private $user;
-
-    /**
-     * Reference tree
-     * @var Tree $tree
-     */
-    private $tree;
-
-    /**
-     * Temporary Sosa table, used during construction
-     * @var array<array<string,mixed>> $tmp_sosa_table
-     */
-    private $tmp_sosa_table;
-
-    /**
-     * Maximum number of generations to calculate
-     * @var int $max_generations
-     */
-    private $max_generations;
-
-    /**
-     * Constructor for the Sosa Calculator
-     *
-     * @param SosaRecordsService $sosa_records_service
-     * @param Tree $tree
-     * @param UserInterface $user
-     */
-    public function __construct(SosaRecordsService $sosa_records_service, Tree $tree, UserInterface $user)
-    {
-        $this->sosa_records_service = $sosa_records_service;
-        $this->tree = $tree;
-        $this->user = $user;
-        $this->tmp_sosa_table = array();
-        $max_gen_setting = $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN');
-        $this->max_generations = is_numeric($max_gen_setting) ?
-            (int) $max_gen_setting :
-            $this->sosa_records_service->maxSystemGenerations();
-    }
-
-    /**
-     * Compute all Sosa ancestors from the user's root individual.
-     *
-     * @return bool Result of the computation
-     */
-    public function computeAll(): bool
-    {
-        $root_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
-        if (($indi = Registry::individualFactory()->make($root_id, $this->tree)) !== null) {
-            $this->sosa_records_service->deleteAll($this->tree, $this->user);
-            $this->addNode($indi, 1);
-            $this->flushTmpSosaTable(true);
-            return true;
-        }
-        return false;
-    }
-
-    /**
-     * Compute all Sosa Ancestors from a specified Individual
-     *
-     * @param Individual $indi
-     * @return bool
-     */
-    public function computeFromIndividual(Individual $indi): bool
-    {
-        $current_sosas = $this->sosa_records_service->sosaNumbers($this->tree, $this->user, $indi);
-        foreach ($current_sosas->keys() as $sosa) {
-            $this->sosa_records_service->deleteAncestorsFrom($this->tree, $this->user, $sosa);
-            $this->addNode($indi, $sosa);
-        }
-        $this->flushTmpSosaTable(true);
-        return true;
-    }
-
-    /**
-     * Recursive method to add individual to the Sosa table, and flush it regularly
-     *
-     * @param Individual $indi Individual to add
-     * @param int $sosa Individual's sosa
-     */
-    private function addNode(Individual $indi, int $sosa): void
-    {
-        $birth_year = $indi->getBirthDate()->gregorianYear();
-        $birth_year_est = $birth_year === 0 ? $indi->getEstimatedBirthDate()->gregorianYear() : $birth_year;
-
-        $death_year = $indi->getDeathDate()->gregorianYear();
-        $death_year_est = $death_year === 0 ? $indi->getEstimatedDeathDate()->gregorianYear() : $death_year;
-
-        $this->tmp_sosa_table[] = [
-            'indi' => $indi->xref(),
-            'sosa' => $sosa,
-            'birth_year' => $birth_year === 0 ? null : $birth_year,
-            'birth_year_est' => $birth_year_est === 0 ? null : $birth_year_est,
-            'death_year' => $death_year === 0 ? null : $death_year,
-            'death_year_est' => $death_year_est === 0 ? null : $death_year_est
-        ];
-
-        $this->flushTmpSosaTable();
-
-        if (
-            ($fam = $indi->childFamilies()->first()) !== null
-            && $this->sosa_records_service->generation($sosa) < $this->max_generations
-        ) {
-            /** @var \Fisharebest\Webtrees\Family $fam */
-            if (($husb = $fam->husband()) !== null) {
-                $this->addNode($husb, 2 * $sosa);
-            }
-            if (($wife = $fam->wife()) !== null) {
-                $this->addNode($wife, 2 * $sosa + 1);
-            }
-        }
-    }
-
-    /**
-     * Write sosas in the table, if the number of items is superior to the limit, or if forced.
-     *
-     * @param bool $force Should the flush be forced
-     */
-    private function flushTmpSosaTable($force = false): void
-    {
-        if ($force || count($this->tmp_sosa_table) >= self::TMP_SOSA_TABLE_LIMIT) {
-            $this->sosa_records_service->insertOrUpdate($this->tree, $this->user, $this->tmp_sosa_table);
-            $this->tmp_sosa_table = array();
-        }
-    }
+	/**
+	 * Maximium size for the temporary Sosa table
+	 * @var int TMP_SOSA_TABLE_LIMIT
+	 */
+	private const TMP_SOSA_TABLE_LIMIT = 1000;
+
+	/**
+	 * @var SosaRecordsService $sosa_records_service
+	 */
+	private $sosa_records_service;
+
+	/**
+	 * Reference user
+	 * @var UserInterface $user
+	 */
+	private $user;
+
+	/**
+	 * Reference tree
+	 * @var Tree $tree
+	 */
+	private $tree;
+
+	/**
+	 * Temporary Sosa table, used during construction
+	 * @var array<array<string,mixed>> $tmp_sosa_table
+	 */
+	private $tmp_sosa_table;
+
+	/**
+	 * Maximum number of generations to calculate
+	 * @var int $max_generations
+	 */
+	private $max_generations;
+
+	/**
+	 * Constructor for the Sosa Calculator
+	 *
+	 * @param SosaRecordsService $sosa_records_service
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 */
+	public function __construct(SosaRecordsService $sosa_records_service, Tree $tree, UserInterface $user)
+	{
+		$this->sosa_records_service = $sosa_records_service;
+		$this->tree = $tree;
+		$this->user = $user;
+		$this->tmp_sosa_table = array();
+		$max_gen_setting = $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN');
+		$this->max_generations = is_numeric($max_gen_setting) ?
+			(int) $max_gen_setting :
+			$this->sosa_records_service->maxSystemGenerations();
+	}
+
+	/**
+	 * Compute all Sosa ancestors from the user's root individual.
+	 *
+	 * @return bool Result of the computation
+	 */
+	public function computeAll(): bool
+	{
+		$root_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
+		if (($indi = Registry::individualFactory()->make($root_id, $this->tree)) !== null) {
+			$this->sosa_records_service->deleteAll($this->tree, $this->user);
+			$this->addNode($indi, 1);
+			$this->flushTmpSosaTable(true);
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * Compute all Sosa Ancestors from a specified Individual
+	 *
+	 * @param Individual $indi
+	 * @return bool
+	 */
+	public function computeFromIndividual(Individual $indi): bool
+	{
+		$current_sosas = $this->sosa_records_service->sosaNumbers($this->tree, $this->user, $indi);
+		foreach ($current_sosas->keys() as $sosa) {
+			$this->sosa_records_service->deleteAncestorsFrom($this->tree, $this->user, $sosa);
+			$this->addNode($indi, $sosa);
+		}
+		$this->flushTmpSosaTable(true);
+		return true;
+	}
+
+	/**
+	 * Recursive method to add individual to the Sosa table, and flush it regularly
+	 *
+	 * @param Individual $indi Individual to add
+	 * @param int $sosa Individual's sosa
+	 */
+	private function addNode(Individual $indi, int $sosa): void
+	{
+		$birth_year = $indi->getBirthDate()->gregorianYear();
+		$birth_year_est = $birth_year === 0 ? $indi->getEstimatedBirthDate()->gregorianYear() : $birth_year;
+
+		$death_year = $indi->getDeathDate()->gregorianYear();
+		$death_year_est = $death_year === 0 ? $indi->getEstimatedDeathDate()->gregorianYear() : $death_year;
+
+		$this->tmp_sosa_table[] = [
+			'indi' => $indi->xref(),
+			'sosa' => $sosa,
+			'birth_year' => $birth_year === 0 ? null : $birth_year,
+			'birth_year_est' => $birth_year_est === 0 ? null : $birth_year_est,
+			'death_year' => $death_year === 0 ? null : $death_year,
+			'death_year_est' => $death_year_est === 0 ? null : $death_year_est
+		];
+
+		$this->flushTmpSosaTable();
+
+		if (
+			($fam = $indi->childFamilies()->first()) !== null
+			&& $this->sosa_records_service->generation($sosa) < $this->max_generations
+		) {
+			/** @var \Fisharebest\Webtrees\Family $fam */
+			if (($husb = $fam->husband()) !== null) {
+				$this->addNode($husb, 2 * $sosa);
+			}
+			if (($wife = $fam->wife()) !== null) {
+				$this->addNode($wife, 2 * $sosa + 1);
+			}
+		}
+	}
+
+	/**
+	 * Write sosas in the table, if the number of items is superior to the limit, or if forced.
+	 *
+	 * @param bool $force Should the flush be forced
+	 */
+	private function flushTmpSosaTable($force = false): void
+	{
+		if ($force || count($this->tmp_sosa_table) >= self::TMP_SOSA_TABLE_LIMIT) {
+			$this->sosa_records_service->insertOrUpdate($this->tree, $this->user, $this->tmp_sosa_table);
+			$this->tmp_sosa_table = array();
+		}
+	}
 }

app/Module/Sosa/GeoAnalyses/SosaByGenerationGeoAnalysis.php

Indentation +97 added lines, -97 removed lines

@@ -31,101 +31,101 @@
  */
 class SosaByGenerationGeoAnalysis implements GeoAnalysisInterface
 {
-    private SosaRecordsService $records_service;
-
-    /**
-     * Constructor for SosaByGenerationGeoAnalysis
-     *
-     * @param SosaRecordsService $records_service
-     */
-    public function __construct(SosaRecordsService $records_service)
-    {
-        $this->records_service = $records_service;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Sosa ancestors places by generation');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::itemsDescription()
-     */
-    public function itemsDescription(): callable
-    {
-        return fn(int $count): string => I18N::plural('ancestor', 'ancestors', $count);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::results()
-     */
-    public function results(Tree $tree, int $depth): GeoAnalysisResults
-    {
-        $results = new GeoAnalysisResults();
-
-        $unique_ancestors = $this->records_service
-            ->listAncestors($tree, Auth::user())
-            ->uniqueStrict(fn(stdClass $item): string => $item->majs_i_id);
-
-        foreach ($unique_ancestors as $item) {
-            $ancestor = Registry::individualFactory()->make($item->majs_i_id, $tree);
-            if ($ancestor === null || !$ancestor->canShow()) {
-                continue;
-            }
-            $generation = $this->records_service->generation((int) $item->majs_sosa);
-            $significantplace = new GeoAnalysisPlace($tree, null, $depth);
-            foreach ($this->significantPlaces($ancestor) as $place) {
-                $significantplace = new GeoAnalysisPlace($tree, $place, $depth, true);
-                if ($significantplace->isKnown()) {
-                    break;
-                }
-            }
-            $results->addPlace($significantplace);
-            $results->addPlaceInCategory(
-                I18N::translate('Generation %s', I18N::number($generation)),
-                $generation,
-                $significantplace
-            );
-        }
-
-        return $results;
-    }
-
-    /**
-     * Returns significant places in order of priority for an individual
-     *
-     * @param Individual $individual
-     * @return Generator<\Fisharebest\Webtrees\Place>
-     */
-    protected function significantPlaces(Individual $individual): Generator
-    {
-        yield $individual->getBirthPlace();
-
-        /** @var \Fisharebest\Webtrees\Fact $fact */
-        foreach ($individual->facts(['RESI']) as $fact) {
-            yield $fact->place();
-        }
-
-        yield $individual->getDeathPlace();
-
-        /** @var \Fisharebest\Webtrees\Family $family */
-        foreach ($individual->childFamilies() as $family) {
-            foreach ($family->facts(['RESI']) as $fact) {
-                yield $fact->place();
-            }
-        }
-
-        /** @var \Fisharebest\Webtrees\Family $family */
-        foreach ($individual->spouseFamilies() as $family) {
-            foreach ($family->facts(['RESI']) as $fact) {
-                yield $fact->place();
-            }
-        }
-    }
+	private SosaRecordsService $records_service;
+
+	/**
+	 * Constructor for SosaByGenerationGeoAnalysis
+	 *
+	 * @param SosaRecordsService $records_service
+	 */
+	public function __construct(SosaRecordsService $records_service)
+	{
+		$this->records_service = $records_service;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Sosa ancestors places by generation');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::itemsDescription()
+	 */
+	public function itemsDescription(): callable
+	{
+		return fn(int $count): string => I18N::plural('ancestor', 'ancestors', $count);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::results()
+	 */
+	public function results(Tree $tree, int $depth): GeoAnalysisResults
+	{
+		$results = new GeoAnalysisResults();
+
+		$unique_ancestors = $this->records_service
+			->listAncestors($tree, Auth::user())
+			->uniqueStrict(fn(stdClass $item): string => $item->majs_i_id);
+
+		foreach ($unique_ancestors as $item) {
+			$ancestor = Registry::individualFactory()->make($item->majs_i_id, $tree);
+			if ($ancestor === null || !$ancestor->canShow()) {
+				continue;
+			}
+			$generation = $this->records_service->generation((int) $item->majs_sosa);
+			$significantplace = new GeoAnalysisPlace($tree, null, $depth);
+			foreach ($this->significantPlaces($ancestor) as $place) {
+				$significantplace = new GeoAnalysisPlace($tree, $place, $depth, true);
+				if ($significantplace->isKnown()) {
+					break;
+				}
+			}
+			$results->addPlace($significantplace);
+			$results->addPlaceInCategory(
+				I18N::translate('Generation %s', I18N::number($generation)),
+				$generation,
+				$significantplace
+			);
+		}
+
+		return $results;
+	}
+
+	/**
+	 * Returns significant places in order of priority for an individual
+	 *
+	 * @param Individual $individual
+	 * @return Generator<\Fisharebest\Webtrees\Place>
+	 */
+	protected function significantPlaces(Individual $individual): Generator
+	{
+		yield $individual->getBirthPlace();
+
+		/** @var \Fisharebest\Webtrees\Fact $fact */
+		foreach ($individual->facts(['RESI']) as $fact) {
+			yield $fact->place();
+		}
+
+		yield $individual->getDeathPlace();
+
+		/** @var \Fisharebest\Webtrees\Family $family */
+		foreach ($individual->childFamilies() as $family) {
+			foreach ($family->facts(['RESI']) as $fact) {
+				yield $fact->place();
+			}
+		}
+
+		/** @var \Fisharebest\Webtrees\Family $family */
+		foreach ($individual->spouseFamilies() as $family) {
+			foreach ($family->facts(['RESI']) as $fact) {
+				yield $fact->place();
+			}
+		}
+	}
 }