Photoprism #496

ISeeTWizard · 2022-04-20T09:57:35Z

Hi - I just have an issue with the livestats on the Photoprism tile.
In fact I need an authentification for the api (I tried to access too over the browser) but there is no such option that I could configure.

Isn't that supported yet?

Thanks

runbmp · 2022-05-06T15:18:08Z

You can try using https://user:[email protected]

ISeeTWizard · 2022-05-06T15:25:20Z

Unfortunately that doesn't work :/
but thanks for the idea

simensen · 2022-06-14T03:53:01Z

I'm curious about this as well! I just tried to use the Photoprism tile and haven't been able to figure out how to "authenticate".

simensen · 2022-06-14T03:57:10Z

It looks like the v1 API uses X-Session-ID and I'm not sure how we could possibly use this with Heimdall, currently. :-/

https://docs.photoprism.app/developer-guide/ui/rest-api/

iwinstar · 2022-09-11T02:55:07Z

I figure out how to solve this problem. You need to change two files under Heimdall deploy path /config/www/SupportedApps/PhotoPrism/ and then re-add PhotoPrism.

config.blade.php

<h2>{{ __('app.apps.config') }} ({{ __('app.optional') }}) @include('items.enable')</h2>
<div class="items">
    <div class="input">
        <label>{{ strtoupper(__('app.url')) }}</label>
        {!! Form::text('config[override_url]', isset($item) ? $item->getconfig()->override_url : null, ['placeholder' => __('app.apps.override'), 'id' => 'override_url', 'class' => 'form-control']) !!}
	</div>
    <div class="input">
        <label title="">Session ID (<a href="https://docs.photoprism.app/developer-guide/api/#with-authentication" target="_blank">help?</a>)</label>
        {!! Form::text('config[session]', isset($item) ? $item->getconfig()->session : null, ['placeholder' => __('Session ID'), 'data-config' => 'session', 'class' => 'form-control config-item']) !!}
    </div>
    <div class="input">
        <button style="margin-top: 32px;" class="btn test" id="test_config">Test</button>
    </div>
</div>

PhotoPrism.php

<?php namespace App\SupportedApps\PhotoPrism;

class PhotoPrism extends \App\SupportedApps implements \App\EnhancedApps
{
	public $config;

	//protected $login_first = true; // Uncomment if api requests need to be authed first
	//protected $method = 'POST';  // Uncomment if requests to the API should be set by POST

	function __construct()
	{
		//$this->jar = new \GuzzleHttp\Cookie\CookieJar; // Uncomment if cookies need to be set
	}

	function get_request_attrs()
    {
		$attrs["headers"] = ["X-Session-ID" => $this->config->session];
        return $attrs;
    }

	public function test()
	{
        $attrs = $this->get_request_attrs();
		$test = parent::appTest($this->url("api/v1/config"), $attrs);
		echo $test->status;
	}

	public function livestats()
	{
		$status = "inactive";
		$attrs = $this->get_request_attrs();
		$res = parent::execute($this->url("api/v1/config"), $attrs);
		$details = json_decode($res->getBody(), true);
		$data = [];

		if ($details) {
			$status = "active";
			$data["photos"] = number_format($details["count"]["photos"]) ?? 0;
			$data["videos"] = number_format($details["count"]["videos"]) ?? 0;
		}

		return parent::getLiveStats($status, $data);
	}

	public function url($endpoint)
	{
		$api_url = parent::normaliseurl($this->config->url) . $endpoint;
		return $api_url;
	}
}

byrongamatos · 2022-12-21T12:43:31Z

Thank you @iwinstar your solution worked great.

EarlJr53 · 2022-12-21T16:59:14Z

@byrongamatos what did you put into the URL and Session ID fields when adding PhotoPrism into Heimdall?

byrongamatos · 2022-12-21T17:29:28Z

@byrongamatos what did you put into the URL and Session ID fields when adding PhotoPrism into Heimdall?

@EarlJr53 Open a new tab and login to photo prism. Then open the developer tools of your browser, and under local storage for photoprism you will find a session token. I copied and used this token

EarlJr53 · 2022-12-21T17:38:17Z

Thank you so much! I got it!

@byrongamatos what did you put into the URL and Session ID fields when adding PhotoPrism into Heimdall?

Open a new tab and login to photo prism. Then open the developer tools of your browser, and under local storage for photoprism you will find a session token. I copied and used this token

ISeeTWizard · 2022-12-21T18:48:11Z

I changed the files too and had to restart my docker heimdall instance
Unfortunately for me it seems not to work :/
At least I don't get any errors - just a message that the communication with the api was successfull
But it writes 0 photos and 0 videos which of course isn't correct

The session_id I took with dev tools (F12 browser - Application tab - Search for Local Storage - Than your URL - than you can find the session_id)

I can even enter what I want as session ID
The communication is always successfull

iwinstar · 2022-12-21T19:06:24Z

I think the session_id you provided maybe expired, you can check it with Postman.

I changed the files too and had to restart my docker heimdall instance Unfortunately for me it seems not to work :/ At least I don't get any errors - just a message that the communication with the api was successfull But it writes 0 photos and 0 videos which of course isn't correct

The session_id I took with dev tools (F12 browser - Application tab - Search for Local Storage - Than your URL - than you can find the session_id)

I can even enter what I want as session ID The communication is always successfull

ISeeTWizard · 2022-12-21T19:18:27Z

No
seems to be something else :/
Maybe due to the reverse proxy - Need to check further

ISeeTWizard · 2022-12-21T19:22:19Z

Hmm OK
not reverse proxy - even with direct connection it doesn't work
I wrote photoprism to see why I just get 0 within the counts

ISeeTWizard · 2022-12-21T19:28:17Z

At least the connection is working
Thanks for that :)

Why the API just returns 0 for everything must be an error somewhere on the photoprism side...
We will see - I will let you know if I figure out if someone else has this issue too

heisenberg2980 · 2023-07-31T22:22:55Z

Could anyone open a PR to apply the solution from @iwinstar to Heimdall code? It would be great if everyone using Heimdall could get this fix without having to find this issue and manually update those files

mvdkleijn · 2024-01-24T16:30:06Z

Hi there! Running through the backlog of issues and PRs... A couple of observations / comments:

The Photoprism REST API is marked as internal, i.e. generally not meant for external use;
Indeed, the only way to authenticate appears to be copying the X-Session-ID header value;
Their documentation mentions unauthenticated access, but doesn't further specify in what cases that can be used, if any.
There is a Go client and a quick look through the code suggests that they use username & password to POST to api/v1/session and then retrieve an X-Session-ID or something equivalent. YMMV.
Though I won't be working on code for this, I'm happy to look over any PRs that are submitted against current master.

Let me know if anyone plans to work on this.

LinuxServer-CI · 2024-02-25T15:18:23Z