mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2026-03-28 19:21:50 -04:00
* Implement code changes to enhance functionality and improve performance * Update nl.json Fix Dutch translations. * feat(security): add Trivy security scans for Docker images and source code * feat(security): restructure Trivy scans for improved clarity and organization * fix(dependencies): update Django version to 5.2.2 * style(workflows): standardize quotes and fix typo in frontend-test.yml * feat(workflows): add job names for clarity in backend and frontend test workflows * refactor(workflows): remove path filters from pull_request and push triggers in backend and frontend workflows * feat(workflows): add paths to push and pull_request triggers for backend and frontend workflows * refactor(workflows): simplify trigger paths for backend and frontend workflows fix(dependencies): add overrides for esbuild in frontend package.json * fix(package): add missing pnpm overrides for esbuild in package.json * fix(workflows): add missing severity parameter for Trivy filesystem scan * fix(workflows): add missing severity parameter for Docker image scans in Trivy workflow * fix(workflows): remove MEDIUM severity from Trivy scans in security workflow * added-fix-image-deletion (#681) * added-fix-image-deletion * feat(commands): add image cleanup command to find and delete unused files * fix(models): ensure associated AdventureImages are deleted and files cleaned up on Adventure deletion * fix(models): ensure associated Attachment files are deleted and their filesystem cleaned up on Adventure deletion --------- Co-authored-by: ferdousahmed <taninme@gmail.com> Co-authored-by: Sean Morley * Rename Adventures to Locations (#696) * Refactor user_id to user in adventures and related models, views, and components - Updated all instances of user_id to user in the adventures app, including models, serializers, views, and frontend components. - Adjusted queries and filters to reflect the new user field naming convention. - Ensured consistency across the codebase for user identification in adventures, collections, notes, and transportation entities. - Modified frontend components to align with the updated data structure, ensuring proper access control and rendering based on user ownership. * Refactor adventure-related views and components to use "Location" terminology - Updated GlobalSearchView to replace AdventureSerializer with LocationSerializer. - Modified IcsCalendarGeneratorViewSet to use LocationSerializer instead of AdventureSerializer. - Created new LocationImageViewSet for managing location images, including primary image toggling and image deletion. - Introduced LocationViewSet for managing locations with enhanced filtering, sorting, and sharing capabilities. - Updated ReverseGeocodeViewSet to utilize LocationSerializer. - Added ActivityTypesView to retrieve distinct activity types from locations. - Refactored user views to replace AdventureSerializer with LocationSerializer. - Updated frontend components to reflect changes from "adventure" to "location", including AdventureCard, AdventureLink, AdventureModal, and others. - Adjusted API endpoints in frontend routes to align with new location-based structure. - Ensured all references to adventures are replaced with locations across the codebase. * refactor: rename adventures to locations across the application - Updated localization files to replace adventure-related terms with location-related terms. - Refactored TypeScript types and variables from Adventure to Location in various routes and components. - Adjusted UI elements and labels to reflect the change from adventures to locations. - Ensured all references to adventures in the codebase are consistent with the new location terminology. * Refactor code structure for improved readability and maintainability * feat: Implement location details page with server-side loading and deletion functionality - Added +page.server.ts to handle server-side loading of additional location info. - Created +page.svelte for displaying location details, including images, visits, and maps. - Integrated GPX file handling and rendering on the map. - Updated map route to link to locations instead of adventures. - Refactored profile and search routes to use LocationCard instead of AdventureCard. * docs: Update terminology from "Adventure" to "Location" and enhance project overview * docs: Clarify collection examples in usage documentation * feat: Enable credentials for GPX file fetch and add CORS_ALLOW_CREDENTIALS setting * Refactor adventure references to locations across the backend and frontend - Updated CategoryViewSet to reflect location context instead of adventures. - Modified ChecklistViewSet to include locations in retrieval logic. - Changed GlobalSearchView to search for locations instead of adventures. - Adjusted IcsCalendarGeneratorViewSet to handle locations instead of adventures. - Refactored LocationImageViewSet to remove unused import. - Updated LocationViewSet to clarify public access for locations. - Changed LodgingViewSet to reference locations instead of adventures. - Modified NoteViewSet to prevent listing all locations. - Updated RecommendationsViewSet to handle locations in parsing and response. - Adjusted ReverseGeocodeViewSet to search through user locations. - Updated StatsViewSet to count locations instead of adventures. - Changed TagsView to reflect activity types for locations. - Updated TransportationViewSet to reference locations instead of adventures. - Added new translations for search results related to locations in multiple languages. - Updated dashboard and profile pages to reflect location counts instead of adventure counts. - Adjusted search routes to handle locations instead of adventures. * Update banner image * style: Update stats component background and border for improved visibility * refactor: Rename AdventureCard and AdventureModal to LocationCard and LocationModal for consistency * Import and Export Functionality (#698) * feat(backup): add BackupViewSet for data export and import functionality * Fixed frontend returning corrupt binary data * feat(import): enhance import functionality with confirmation check and improved city/region/country handling * Potential fix for code scanning alert no. 29: Information exposure through an exception Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> * Refactor response handling to use arrayBuffer instead of bytes * Refactor image cleanup command to use LocationImage model and update import/export view to include backup and restore functionality * Update backup export versioning and improve data restore warning message * Enhance image navigation and localization support in modal components * Refactor location handling in Immich integration components for consistency * Enhance backup and restore functionality with improved localization and error handling * Improve accessibility by adding 'for' attribute to backup file input label --------- Co-authored-by: Christian Zäske <blitzdose@gmail.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> * refactor(serializers): rename Location to Adventure and update related fields * refactor(serializers): rename Adventure to Location and update related fields * chore(requirements): update pillow version to 11.3.0 * Add PT-BR translations (#739) * Fixed frontend returning corrupt binary data * fix(adventure): enhance collection ownership validation in AdventureSerializer (#723) * Add PT-BR translations Add translation for Brazilian Portuguese to the project; Signed-off-by: Lucas Zampieri <lzampier@redhat.com> --------- Signed-off-by: Lucas Zampieri <lzampier@redhat.com> Co-authored-by: Sean Morley <98704938+seanmorley15@users.noreply.github.com> Co-authored-by: Christian Zäske <blitzdose@gmail.com> * fix: update date formatting for adventure items to include timezone * Image/attachment overhaul, activities, trails and integrations with Strava and Wanderer (#726) * refactor(models, views, serializers): rename LocationImage and Attachment to ContentImage and ContentAttachment, update related references * feat: Enhance collection sharing and location management features - Implemented unsharing functionality in CollectionViewSet, including removal of user-owned locations from collections. - Refactored ContentImageViewSet to support multiple content types and improved permission checks for image uploads. - Added user ownership checks in LocationViewSet for delete operations. - Enhanced collection management in the frontend to display both owned and shared collections separately. - Updated Immich integration to handle access control based on location visibility and user permissions. - Improved UI components to show creator information and manage collection links more effectively. - Added loading states and error handling in collection fetching logic. * feat: enhance transportation card and modal with image handling - Added CardCarousel component to TransportationCard for image display. - Implemented privacy indicator with Eye and EyeOff icons. - Introduced image upload functionality in TransportationModal, allowing users to upload multiple images. - Added image management features: remove image and set primary image. - Updated Transportation and Location types to include images as ContentImage array. - Enhanced UI for image upload and display in modal, including selected images preview and current images management. * feat: update CardCarousel component to handle images, name, and icon props across various cards * feat: add Discord link to AboutModal and update appVersion in config * feat: add LocationQuickStart and LocationVisits components for enhanced location selection and visit management - Implemented LocationQuickStart.svelte for searching and selecting locations on a map with reverse geocoding. - Created LocationVisits.svelte to manage visit dates and notes for locations, including timezone handling and validation. - Updated types to remove location property from Attachment type. - Modified locations page to integrate NewLocationModal for creating and editing locations, syncing updates with adventures. * feat: update button styles and add back and close functionality in location components * Collection invite system * feat: update CollectionSerializer to include 'shared_with' as a read-only field; update app version; add new background images and localization strings for invites * feat: add Strava integration with OAuth flow and activity management - Implemented IntegrationView for listing integrations including Immich, Google Maps, and Strava. - Created StravaIntegrationView for handling OAuth authorization and token exchange. - Added functionality to refresh Strava access tokens when needed. - Implemented endpoints to fetch user activities from Strava and extract essential information. - Added Strava logo asset and integrated it into the frontend settings page. - Updated settings page to display Strava integration status. - Enhanced location management to include trails with create, edit, and delete functionalities. - Updated types and localization files to support new features. * feat: enhance Strava integration with user-specific settings and management options; update localization strings * feat: update Strava integration settings and add Wanderer logo; enhance user experience with active section management * Add StravaActivity and Activity types to types.ts - Introduced StravaActivity type to represent detailed activity data from Strava. - Added Activity type to encapsulate user activities, including optional trail and GPX file information. - Updated Location type to include an array of activities associated with each visit. * feat: streamline location and activity management; enhance Strava import functionality and add activity handling in server actions * feat: add ActivityCard component and update LocationVisits to use it; modify Activity type to reference trail as string * feat: add geojson support to ActivitySerializer and ActivityCard; enhance location page with activity summaries and GPS tracks * feat: add trails property to recommendation object in collection page * feat: add Wanderer integration with authentication and management features * feat: implement Wanderer integration with trail management and UI components; enhance settings for reauthentication * feat: add measurement system field to CustomUser model and update related serializers, migrations, and UI components * feat: add measurement system support across ActivityCard, StravaActivityCard, NewLocationModal, LocationVisits, and related utility functions * feat: enhance Wanderer integration with trail data fetching and UI updates; add measurement system support * feat: add TrailCard component for displaying trail details with measurement system support * feat: add wanderer link support in TrailSerializer and TrailCard; update measurement system handling in location page * feat: integrate memcached for caching in Wanderer services; update Docker, settings, and supervisord configurations * feat: add activity statistics to user profile; include distance, moving time, elevation, and total activities * feat: enhance import/export functionality to include trails and activities; update UI components and localization * feat: integrate NewLocationModal across various components; update location handling and state management * Refactor Location and Visit types: Replace visits structure in Location with Visit type and add location, created_at, and updated_at fields to Visit * feat: enhance permissions and validation in activity, trail, and visit views; add unique constraint to CollectionInvite model * feat: sync visits when updating adventures in collection page * feat: add geojson support for attachments and refactor GPX handling in location page * chore: remove unused dependencies from pnpm-lock.yaml * feat: add Strava and Wanderer integration documentation and configuration options * Add support for Japanese and Arabic languages in localization * Add new localization strings for Russian, Swedish, and Chinese languages - Updated translations in ru.json, sv.json, and zh.json to include new phrases related to collections, activities, and integrations. - Added strings for leaving collections, loading collections, and quick start instructions. - Included new sections for invites and Strava integration with relevant messages. - Enhanced Google Maps integration descriptions for clarity. * Add localization support for activity-related features and update UI labels - Added new Russian, Swedish, and Chinese translations for activity statistics, achievements, and related terms. - Updated UI components to use localized strings for activity statistics, distance, moving time, and other relevant fields. - Enhanced user experience by ensuring all relevant buttons and labels are translated and accessible. * fix: update appVersion to reflect the latest development version * feat: add getActivityColor function and integrate activity color coding in map and location pages * feat: add support for showing activities and visited cities on the map * feat: update map page to display counts for visited cities and activities * fix: remove debug print statement from IsOwnerOrSharedWithFullAccess permission class * feat: add MapStyleSelector component and integrate basemap selection in map page * feat: enhance basemap functions with 3D terrain support and update XYZ style handling * feat: add management command to recalculate elevation data from GPX files and update activity view to handle elevation data extraction * feat: update MapStyleSelector component and enhance basemap options for improved user experience * feat: refactor activity model and admin to use sport_type, update serializers and components for improved activity handling * feat: update Activity model string representation to use sport_type instead of type * feat: update activity handling to use sport_type for color determination in map and location components * feat: Add attachments support to Transportation and Lodging types - Updated Transportation and Lodging types to include attachments array. - Enhanced localization files for multiple languages to include new strings related to attachments, lodging, and transportation. - Added error and success messages for attachment removal and upload information. - Included new prompts for creating and updating lodging and transportation details across various languages. * feat: Enhance activity statistics and breakdown by category in user profile * feat: Add SPORT_CATEGORIES for better organization of sports types and update StatsViewSet to use it * feat: Enhance CategoryDropdown for mobile responsiveness and add category creation functionality * feat: Update inspirational quote in adventure log * feat: Localize navigation labels in Navbar and add translation to en.json * feat: Update navigation elements to use anchor tags for better accessibility and add new fields to signup form * Translate login button text to support internationalization * feat: Refactor location visit status logic and add utility function for visited locations count * chore: Upgrade GitHub Actions and remove unused timezone import * fix: Update Docker image tags in GitHub Actions workflow for consistency * fix: Update Docker image build process to use BuildKit cache for improved performance * chore: Remove unused imports from stats_view.py for cleaner code * Increase background image opacity on login and signup pages for improved visibility * fix: Add postgresql-client to runtime dependencies in Dockerfile * fix: Update workflow files to include permissions for GitHub Actions * fix: Update esbuild version to ^0.25.9 in package.json and pnpm-lock.yaml for compatibility * chore: improve Chinese translation (#796) * fix: update adventure log quote and remove unused activity type field * fix: optimize import process by using get_or_create for visited cities and regions * fix: update README to reflect changes from adventures to locations and enhance feature descriptions * fix: update documentation to reflect changes from adventures to locations and enhance feature descriptions * Update google_maps_integration.md (#743) * Update google_maps_integration.md Explain APIs needed for AdventureLogs versions. Fixes #731 and #727 * Fix a typo google_maps_integration.md --------- Co-authored-by: Sean Morley <98704938+seanmorley15@users.noreply.github.com> * fix: update appVersion to reflect the main branch version * fix: update image source for satellite map in documentation * Update frontend/src/lib/components/NewLocationModal.svelte Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add localization updates for multiple languages - Japanese (ja.json): Added new activity-related phrases and checklist terms. - Korean (ko.json): Included activity breakdown and checklist enhancements. - Dutch (nl.json): Updated activity descriptions and added checklist functionalities. - Norwegian (no.json): Enhanced activity and checklist terminology. - Polish (pl.json): Added new phrases for activities and checklist management. - Brazilian Portuguese (pt-br.json): Updated activity-related terms and checklist features. - Russian (ru.json): Included new phrases for activities and checklist management. - Swedish (sv.json): Enhanced activity descriptions and checklist functionalities. - Chinese (zh.json): Added new activity-related phrases and checklist terms. * fix: enhance image upload handling to support immich_id * Add "not_enabled" message for Strava integration in multiple languages - Updated Spanish, French, Italian, Japanese, Korean, Dutch, Norwegian, Polish, Brazilian Portuguese, Russian, Swedish, and Chinese locale files to include a new message indicating that Strava integration is not enabled in the current instance. --------- Signed-off-by: Lucas Zampieri <lzampier@redhat.com> Co-authored-by: Ycer0n <37674033+Ycer0n@users.noreply.github.com> Co-authored-by: taninme <5262715+taninme@users.noreply.github.com> Co-authored-by: ferdousahmed <taninme@gmail.com> Co-authored-by: Christian Zäske <blitzdose@gmail.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Lucas Zampieri <lcasmz54@gmail.com> Co-authored-by: pplulee <pplulee@live.cn> Co-authored-by: Cathelijne Hornstra <github@hornstra.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
589 lines
25 KiB
Python
589 lines
25 KiB
Python
import os
|
|
from rest_framework.response import Response
|
|
from rest_framework import viewsets, status
|
|
from integrations.serializers import ImmichIntegrationSerializer
|
|
from integrations.models import ImmichIntegration
|
|
from rest_framework.decorators import action
|
|
from rest_framework.permissions import IsAuthenticated
|
|
import requests
|
|
from adventures.models import ContentImage
|
|
from django.http import HttpResponse
|
|
from django.shortcuts import get_object_or_404
|
|
from integrations.utils import StandardResultsSetPagination
|
|
import logging
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
class ImmichIntegrationView(viewsets.ViewSet):
|
|
permission_classes = [IsAuthenticated]
|
|
pagination_class = StandardResultsSetPagination
|
|
|
|
def check_integration(self, request):
|
|
"""
|
|
Checks if the user has an active Immich integration.
|
|
Returns:
|
|
- The integration object if it exists.
|
|
- A Response with an error message if the integration is missing.
|
|
"""
|
|
if not request.user.is_authenticated:
|
|
return Response(
|
|
{
|
|
'message': 'You need to be authenticated to use this feature.',
|
|
'error': True,
|
|
'code': 'immich.authentication_required'
|
|
},
|
|
status=status.HTTP_403_FORBIDDEN
|
|
)
|
|
|
|
user_integrations = ImmichIntegration.objects.filter(user=request.user)
|
|
if not user_integrations.exists():
|
|
return Response(
|
|
{
|
|
'message': 'You need to have an active Immich integration to use this feature.',
|
|
'error': True,
|
|
'code': 'immich.integration_missing'
|
|
},
|
|
status=status.HTTP_403_FORBIDDEN
|
|
)
|
|
|
|
return user_integrations.first()
|
|
|
|
@action(detail=False, methods=['get'], url_path='search')
|
|
def search(self, request):
|
|
"""
|
|
Handles the logic for searching Immich images.
|
|
"""
|
|
# Check for integration before proceeding
|
|
integration = self.check_integration(request)
|
|
if isinstance(integration, Response):
|
|
return integration
|
|
|
|
query = request.query_params.get('query', '')
|
|
date = request.query_params.get('date', '')
|
|
|
|
if not query and not date:
|
|
return Response(
|
|
{
|
|
'message': 'Query or date is required.',
|
|
'error': True,
|
|
'code': 'immich.query_required'
|
|
},
|
|
status=status.HTTP_400_BAD_REQUEST
|
|
)
|
|
|
|
arguments = {}
|
|
if query:
|
|
arguments['query'] = query
|
|
if date:
|
|
# Create date range for the entire selected day
|
|
from datetime import datetime, timedelta
|
|
try:
|
|
# Parse the date and create start/end of day
|
|
selected_date = datetime.strptime(date, '%Y-%m-%d')
|
|
start_of_day = selected_date.strftime('%Y-%m-%d')
|
|
end_of_day = (selected_date + timedelta(days=1)).strftime('%Y-%m-%d')
|
|
|
|
arguments['takenAfter'] = start_of_day
|
|
arguments['takenBefore'] = end_of_day
|
|
except ValueError:
|
|
return Response(
|
|
{
|
|
'message': 'Invalid date format. Use YYYY-MM-DD.',
|
|
'error': True,
|
|
'code': 'immich.invalid_date_format'
|
|
},
|
|
status=status.HTTP_400_BAD_REQUEST
|
|
)
|
|
|
|
# check so if the server is down, it does not tweak out like a madman and crash the server with a 500 error code
|
|
try:
|
|
url = f'{integration.server_url}/search/{"smart" if query else "metadata"}'
|
|
immich_fetch = requests.post(url, headers={
|
|
'x-api-key': integration.api_key
|
|
},
|
|
json = arguments
|
|
)
|
|
res = immich_fetch.json()
|
|
except requests.exceptions.ConnectionError:
|
|
return Response(
|
|
{
|
|
'message': 'The Immich server is currently down or unreachable.',
|
|
'error': True,
|
|
'code': 'immich.server_down'
|
|
},
|
|
status=status.HTTP_503_SERVICE_UNAVAILABLE
|
|
)
|
|
|
|
if 'assets' in res and 'items' in res['assets']:
|
|
paginator = self.pagination_class()
|
|
# for each item in the items, we need to add the image url to the item so we can display it in the frontend
|
|
public_url = os.environ.get('PUBLIC_URL', 'http://127.0.0.1:8000').rstrip('/')
|
|
public_url = public_url.replace("'", "")
|
|
for item in res['assets']['items']:
|
|
item['image_url'] = f'{public_url}/api/integrations/immich/{integration.id}/get/{item["id"]}'
|
|
result_page = paginator.paginate_queryset(res['assets']['items'], request)
|
|
return paginator.get_paginated_response(result_page)
|
|
else:
|
|
return Response(
|
|
{
|
|
'message': 'No items found.',
|
|
'error': True,
|
|
'code': 'immich.no_items_found'
|
|
},
|
|
status=status.HTTP_404_NOT_FOUND
|
|
)
|
|
|
|
@action(detail=False, methods=['get'])
|
|
def albums(self, request):
|
|
"""
|
|
RESTful GET method for retrieving all Immich albums.
|
|
"""
|
|
# Check for integration before proceeding
|
|
integration = self.check_integration(request)
|
|
if isinstance(integration, Response):
|
|
return integration
|
|
|
|
# check so if the server is down, it does not tweak out like a madman and crash the server with a 500 error code
|
|
try:
|
|
immich_fetch = requests.get(f'{integration.server_url}/albums', headers={
|
|
'x-api-key': integration.api_key
|
|
})
|
|
res = immich_fetch.json()
|
|
except requests.exceptions.ConnectionError:
|
|
return Response(
|
|
{
|
|
'message': 'The Immich server is currently down or unreachable.',
|
|
'error': True,
|
|
'code': 'immich.server_down'
|
|
},
|
|
status=status.HTTP_503_SERVICE_UNAVAILABLE
|
|
)
|
|
|
|
return Response(
|
|
res,
|
|
status=status.HTTP_200_OK
|
|
)
|
|
|
|
@action(detail=False, methods=['get'], url_path='albums/(?P<albumid>[^/.]+)')
|
|
def album(self, request, albumid=None):
|
|
"""
|
|
RESTful GET method for retrieving a specific Immich album by ID.
|
|
"""
|
|
# Check for integration before proceeding
|
|
integration = self.check_integration(request)
|
|
print(integration.user)
|
|
if isinstance(integration, Response):
|
|
return integration
|
|
|
|
if not albumid:
|
|
return Response(
|
|
{
|
|
'message': 'Album ID is required.',
|
|
'error': True,
|
|
'code': 'immich.albumid_required'
|
|
},
|
|
status=status.HTTP_400_BAD_REQUEST
|
|
)
|
|
|
|
# check so if the server is down, it does not tweak out like a madman and crash the server with a 500 error code
|
|
try:
|
|
immich_fetch = requests.get(f'{integration.server_url}/albums/{albumid}', headers={
|
|
'x-api-key': integration.api_key
|
|
})
|
|
res = immich_fetch.json()
|
|
except requests.exceptions.ConnectionError:
|
|
return Response(
|
|
{
|
|
'message': 'The Immich server is currently down or unreachable.',
|
|
'error': True,
|
|
'code': 'immich.server_down'
|
|
},
|
|
status=status.HTTP_503_SERVICE_UNAVAILABLE
|
|
)
|
|
|
|
if 'assets' in res:
|
|
paginator = self.pagination_class()
|
|
# for each item in the items, we need to add the image url to the item so we can display it in the frontend
|
|
public_url = os.environ.get('PUBLIC_URL', 'http://127.0.0.1:8000').rstrip('/')
|
|
public_url = public_url.replace("'", "")
|
|
for item in res['assets']:
|
|
item['image_url'] = f'{public_url}/api/integrations/immich/{integration.id}/get/{item["id"]}'
|
|
result_page = paginator.paginate_queryset(res['assets'], request)
|
|
return paginator.get_paginated_response(result_page)
|
|
else:
|
|
return Response(
|
|
{
|
|
'message': 'No assets found in this album.',
|
|
'error': True,
|
|
'code': 'immich.no_assets_found'
|
|
},
|
|
status=status.HTTP_404_NOT_FOUND
|
|
)
|
|
|
|
@action(
|
|
detail=False,
|
|
methods=['get'],
|
|
url_path='(?P<integration_id>[^/.]+)/get/(?P<imageid>[^/.]+)',
|
|
permission_classes=[]
|
|
)
|
|
def get_by_integration(self, request, integration_id=None, imageid=None):
|
|
"""
|
|
GET an Immich image using the integration and asset ID.
|
|
Access levels (in order of priority):
|
|
1. Public locations: accessible by anyone
|
|
2. Private locations in public collections: accessible by anyone
|
|
3. Private locations in private collections shared with user: accessible by shared users, and the collection owner
|
|
4. Private locations: accessible only to the owner
|
|
5. No ContentImage: owner can still view via integration
|
|
"""
|
|
if not imageid or not integration_id:
|
|
return Response({
|
|
'message': 'Image ID and Integration ID are required.',
|
|
'error': True,
|
|
'code': 'immich.missing_params'
|
|
}, status=status.HTTP_400_BAD_REQUEST)
|
|
|
|
# Lookup integration and user
|
|
integration = get_object_or_404(ImmichIntegration, id=integration_id)
|
|
owner_id = integration.user
|
|
|
|
# Get all images for this immich_id and user
|
|
image_entries = list(
|
|
ContentImage.objects
|
|
.filter(immich_id=imageid, user=owner_id)
|
|
.select_related('content_type')
|
|
)
|
|
|
|
# Sort by access level priority and find the best match
|
|
def get_access_priority(image_entry):
|
|
"""Return priority score for access control (lower = higher priority)"""
|
|
content_obj = image_entry.content_object
|
|
|
|
# Only handle Location objects for now (can be extended for other types)
|
|
if not hasattr(content_obj, 'is_public'):
|
|
return 999 # Low priority for non-location objects
|
|
|
|
# For Location objects, check access levels
|
|
if content_obj.is_public:
|
|
return 0 # Highest priority - public location
|
|
|
|
# Check if location is in any public collection
|
|
if hasattr(content_obj, 'collections'):
|
|
collections = content_obj.collections.all()
|
|
if any(collection.is_public for collection in collections):
|
|
return 1 # Second priority - private location in public collection
|
|
|
|
# Check for shared collections (if user is authenticated)
|
|
if (request.user.is_authenticated and
|
|
any(collection.shared_with.filter(id=request.user.id).exists()
|
|
for collection in collections)):
|
|
return 2 # Third priority - shared collection access
|
|
|
|
return 3 # Lowest priority - private location, owner access only
|
|
|
|
# Sort image entries by access priority
|
|
image_entries.sort(key=get_access_priority)
|
|
image_entry = image_entries[0] if image_entries else None
|
|
|
|
# Access control
|
|
if image_entry:
|
|
content_obj = image_entry.content_object
|
|
|
|
# Only apply access control to Location objects
|
|
if hasattr(content_obj, 'is_public'):
|
|
location = content_obj
|
|
|
|
# Determine access level
|
|
is_authorized = False
|
|
|
|
# Level 1: Public location (highest priority)
|
|
if location.is_public:
|
|
is_authorized = True
|
|
|
|
# Level 2: Private location in any public collection
|
|
elif hasattr(location, 'collections'):
|
|
collections = location.collections.all()
|
|
if any(collection.is_public for collection in collections):
|
|
is_authorized = True
|
|
|
|
# Level 3: Owner access
|
|
elif request.user.is_authenticated and request.user == owner_id:
|
|
is_authorized = True
|
|
|
|
# Level 4: Shared collection access or collection owner access
|
|
elif (request.user.is_authenticated and
|
|
(any(collection.shared_with.filter(id=request.user.id).exists()
|
|
for collection in collections) or
|
|
any(collection.user == request.user for collection in collections))):
|
|
is_authorized = True
|
|
else:
|
|
# Location without collections - owner access only
|
|
if request.user.is_authenticated and request.user == owner_id:
|
|
is_authorized = True
|
|
|
|
if not is_authorized:
|
|
return Response({
|
|
'message': 'This image belongs to a private location and you are not authorized.',
|
|
'error': True,
|
|
'code': 'immich.permission_denied'
|
|
}, status=status.HTTP_403_FORBIDDEN)
|
|
else:
|
|
# For non-Location objects, allow only owner access for now
|
|
if not request.user.is_authenticated or request.user != owner_id:
|
|
return Response({
|
|
'message': 'This image is not publicly accessible and you are not the owner.',
|
|
'error': True,
|
|
'code': 'immich.permission_denied'
|
|
}, status=status.HTTP_403_FORBIDDEN)
|
|
else:
|
|
# No ContentImage exists; allow only the integration owner
|
|
if not request.user.is_authenticated or request.user != owner_id:
|
|
return Response({
|
|
'message': 'Image is not linked to any location and you are not the owner.',
|
|
'error': True,
|
|
'code': 'immich.not_found'
|
|
}, status=status.HTTP_404_NOT_FOUND)
|
|
|
|
# Fetch from Immich
|
|
try:
|
|
immich_response = requests.get(
|
|
f'{integration.server_url}/assets/{imageid}/thumbnail?size=preview',
|
|
headers={'x-api-key': integration.api_key},
|
|
timeout=5
|
|
)
|
|
content_type = immich_response.headers.get('Content-Type', 'image/jpeg')
|
|
if not content_type.startswith('image/'):
|
|
return Response({
|
|
'message': 'Invalid content type returned from Immich.',
|
|
'error': True,
|
|
'code': 'immich.invalid_content'
|
|
}, status=status.HTTP_502_BAD_GATEWAY)
|
|
|
|
response = HttpResponse(immich_response.content, content_type=content_type, status=200)
|
|
response['Cache-Control'] = 'public, max-age=86400, stale-while-revalidate=3600'
|
|
return response
|
|
|
|
except requests.exceptions.ConnectionError:
|
|
return Response({
|
|
'message': 'The Immich server is unreachable.',
|
|
'error': True,
|
|
'code': 'immich.server_down'
|
|
}, status=status.HTTP_503_SERVICE_UNAVAILABLE)
|
|
|
|
except requests.exceptions.Timeout:
|
|
return Response({
|
|
'message': 'The Immich server request timed out.',
|
|
'error': True,
|
|
'code': 'immich.timeout'
|
|
}, status=status.HTTP_504_GATEWAY_TIMEOUT)
|
|
|
|
class ImmichIntegrationViewSet(viewsets.ModelViewSet):
|
|
permission_classes = [IsAuthenticated]
|
|
serializer_class = ImmichIntegrationSerializer
|
|
queryset = ImmichIntegration.objects.all()
|
|
|
|
def get_queryset(self):
|
|
return ImmichIntegration.objects.filter(user=self.request.user)
|
|
|
|
def _validate_immich_connection(self, server_url, api_key):
|
|
"""
|
|
Validate connection to Immich server before saving integration.
|
|
Returns tuple: (is_valid, corrected_server_url, error_message)
|
|
"""
|
|
if not server_url or not api_key:
|
|
return False, server_url, "Server URL and API key are required"
|
|
|
|
# Ensure server_url has proper format
|
|
if not server_url.startswith(('http://', 'https://')):
|
|
server_url = f"https://{server_url}"
|
|
|
|
# Remove trailing slash if present
|
|
original_server_url = server_url.rstrip('/')
|
|
|
|
# Try both with and without /api prefix
|
|
test_configs = [
|
|
(original_server_url, f"{original_server_url}/users/me"),
|
|
(f"{original_server_url}/api", f"{original_server_url}/api/users/me")
|
|
]
|
|
|
|
headers = {
|
|
'X-API-Key': api_key,
|
|
'Content-Type': 'application/json'
|
|
}
|
|
|
|
for corrected_url, test_endpoint in test_configs:
|
|
try:
|
|
response = requests.get(
|
|
test_endpoint,
|
|
headers=headers,
|
|
timeout=10, # 10 second timeout
|
|
verify=True # SSL verification
|
|
)
|
|
|
|
if response.status_code == 200:
|
|
try:
|
|
json_response = response.json()
|
|
# Validate expected Immich user response structure
|
|
required_fields = ['id', 'email', 'name', 'isAdmin', 'createdAt']
|
|
if all(field in json_response for field in required_fields):
|
|
return True, corrected_url, None
|
|
else:
|
|
continue # Try next endpoint
|
|
except (ValueError, KeyError):
|
|
continue # Try next endpoint
|
|
elif response.status_code == 401:
|
|
return False, original_server_url, "Invalid API key or unauthorized access"
|
|
elif response.status_code == 403:
|
|
return False, original_server_url, "Access forbidden - check API key permissions"
|
|
# Continue to next endpoint for 404 errors
|
|
|
|
except requests.exceptions.ConnectTimeout:
|
|
return False, original_server_url, "Connection timeout - server may be unreachable"
|
|
except requests.exceptions.ConnectionError:
|
|
return False, original_server_url, "Cannot connect to server - check URL and network connectivity"
|
|
except requests.exceptions.SSLError:
|
|
return False, original_server_url, "SSL certificate error - check server certificate"
|
|
except requests.exceptions.RequestException as e:
|
|
logger.error(f"RequestException during Immich connection validation: {str(e)}")
|
|
return False, original_server_url, "Connection failed due to a network error."
|
|
except Exception as e:
|
|
logger.error(f"Unexpected error during Immich connection validation: {str(e)}")
|
|
return False, original_server_url, "An unexpected error occurred while validating the connection."
|
|
|
|
# If we get here, none of the endpoints worked
|
|
return False, original_server_url, "Immich server endpoint not found - check server URL"
|
|
|
|
def create(self, request):
|
|
"""
|
|
RESTful POST method for creating a new Immich integration.
|
|
"""
|
|
# Check if the user already has an integration
|
|
user_integrations = ImmichIntegration.objects.filter(user=request.user)
|
|
if user_integrations.exists():
|
|
return Response(
|
|
{
|
|
'message': 'You already have an active Immich integration.',
|
|
'error': True,
|
|
'code': 'immich.integration_exists'
|
|
},
|
|
status=status.HTTP_400_BAD_REQUEST
|
|
)
|
|
|
|
serializer = self.serializer_class(data=request.data)
|
|
if serializer.is_valid():
|
|
# Validate Immich server connection before saving
|
|
server_url = serializer.validated_data.get('server_url')
|
|
api_key = serializer.validated_data.get('api_key')
|
|
|
|
is_valid, corrected_server_url, error_message = self._validate_immich_connection(server_url, api_key)
|
|
|
|
if not is_valid:
|
|
return Response(
|
|
{
|
|
'message': f'Cannot connect to Immich server: {error_message}',
|
|
'error': True,
|
|
'code': 'immich.connection_failed',
|
|
'details': error_message
|
|
},
|
|
status=status.HTTP_400_BAD_REQUEST
|
|
)
|
|
|
|
# If validation passes, save the integration with the corrected URL
|
|
serializer.save(user=request.user, server_url=corrected_server_url)
|
|
return Response(
|
|
serializer.data,
|
|
status=status.HTTP_201_CREATED
|
|
)
|
|
|
|
return Response(
|
|
serializer.errors,
|
|
status=status.HTTP_400_BAD_REQUEST
|
|
)
|
|
|
|
def update(self, request, pk=None):
|
|
"""
|
|
RESTful PUT method for updating an existing Immich integration.
|
|
"""
|
|
integration = ImmichIntegration.objects.filter(user=request.user, id=pk).first()
|
|
if not integration:
|
|
return Response(
|
|
{
|
|
'message': 'Integration not found.',
|
|
'error': True,
|
|
'code': 'immich.integration_not_found'
|
|
},
|
|
status=status.HTTP_404_NOT_FOUND
|
|
)
|
|
|
|
serializer = self.serializer_class(integration, data=request.data, partial=True)
|
|
if serializer.is_valid():
|
|
# Validate Immich server connection before updating
|
|
server_url = serializer.validated_data.get('server_url', integration.server_url)
|
|
api_key = serializer.validated_data.get('api_key', integration.api_key)
|
|
|
|
is_valid, corrected_server_url, error_message = self._validate_immich_connection(server_url, api_key)
|
|
|
|
if not is_valid:
|
|
return Response(
|
|
{
|
|
'message': f'Cannot connect to Immich server: {error_message}',
|
|
'error': True,
|
|
'code': 'immich.connection_failed',
|
|
'details': error_message
|
|
},
|
|
status=status.HTTP_400_BAD_REQUEST
|
|
)
|
|
|
|
# If validation passes, save the integration with the corrected URL
|
|
serializer.save(server_url=corrected_server_url)
|
|
return Response(
|
|
serializer.data,
|
|
status=status.HTTP_200_OK
|
|
)
|
|
|
|
return Response(
|
|
serializer.errors,
|
|
status=status.HTTP_400_BAD_REQUEST
|
|
)
|
|
|
|
def destroy(self, request, pk=None):
|
|
"""
|
|
RESTful DELETE method for deleting an existing Immich integration.
|
|
"""
|
|
integration = ImmichIntegration.objects.filter(user=request.user, id=pk).first()
|
|
if not integration:
|
|
return Response(
|
|
{
|
|
'message': 'Integration not found.',
|
|
'error': True,
|
|
'code': 'immich.integration_not_found'
|
|
},
|
|
status=status.HTTP_404_NOT_FOUND
|
|
)
|
|
integration.delete()
|
|
return Response(
|
|
{
|
|
'message': 'Integration deleted successfully.'
|
|
},
|
|
status=status.HTTP_200_OK
|
|
)
|
|
|
|
def list(self, request, *args, **kwargs):
|
|
# If the user has an integration, we only want to return that integration
|
|
user_integrations = ImmichIntegration.objects.filter(user=request.user)
|
|
if user_integrations.exists():
|
|
integration = user_integrations.first()
|
|
serializer = self.serializer_class(integration)
|
|
return Response(
|
|
serializer.data,
|
|
status=status.HTTP_200_OK
|
|
)
|
|
else:
|
|
return Response(
|
|
{
|
|
'message': 'No integration found.',
|
|
'error': True,
|
|
'code': 'immich.integration_not_found'
|
|
},
|
|
status=status.HTTP_404_NOT_FOUND
|
|
) |