Add Face Name, Date, and Event Search with Auto-Redirect #579
Conversation
📝 WalkthroughWalkthroughReplaces static cluster handling with data-driven cluster fetching and Redux storage; adds a new Changes
Sequence Diagram(s)sequenceDiagram
actor User
participant Navbar
participant Redux
participant API
participant SearchPage
participant Gallery
User->>Navbar: Type query / focus input
Navbar->>API: fetchAllClusters (usePictoQuery)
API-->>Redux: clusters
Redux-->>Navbar: clusters (setClusters)
Navbar->>Navbar: show suggestions (faces, dates)
User->>Navbar: select suggestion / press Enter
Navbar->>SearchPage: navigate to /search/:query
SearchPage->>API: fetch images for query
API-->>SearchPage: images
SearchPage->>Redux: store images
alt query matches cluster
SearchPage->>User: redirect to person page
else
SearchPage->>Gallery: render ChronologicalGallery (filtered)
Gallery-->>User: display images
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 3❌ Failed checks (2 warnings, 1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/backend/backend_python/openapi.json (1)
2003-2014: Keep theMetadataModelcontract while permitting extra keys.Switching
metadatato a bare"additionalProperties": trueobject drops every documented field/requirement thatMetadataModelused to guarantee (name,date_created, dimensions, etc.). Any client generated from this spec will now treat cluster metadata as an untyped bag, which is a regression for both validation and DX. If the goal is to allow extra keys, keep the original schema and layer the looseness on top, e.g.:"metadata": { "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, + { + "allOf": [ + { "$ref": "#/components/schemas/MetadataModel" }, + { "type": "object", "additionalProperties": true } + ] + }, { "type": "null" } ], "title": "Metadata" },That preserves the documented base shape while still tolerating future metadata extensions. Please restore the structured contract (or otherwise justify why the required fields can no longer be guaranteed) before landing.
🧹 Nitpick comments (8)
frontend/src/pages/Home/Home.tsx (1)
62-64: Remove leftover debug effect.The commented-out
useEffectwas likely a temporary log and now just adds noise. Please drop it (or replace with a proper dev logger if you still need this visibility).frontend/src/pages/PersonImages/PersonImages.tsx (1)
47-47: Remove debug log (stale and noisy).Logs large arrays, risks PII exposure, and is stale since
imagesisn’t a dependency. Remove before merge.- console.log(images);frontend/src/components/Navigation/Navbar/Navbar.tsx (4)
104-109: Use generatePath with ROUTES to build URLs safely.Avoid hand-built paths; ensures correct encoding and param substitution.
+ import { generatePath } from 'react-router'; + import { ROUTES } from '@/constants/routes'; const handleSuggestionClick = (suggestion: string) => { if (!suggestion) return; setData(suggestion); - navigate(`/search/${encodeURIComponent(suggestion)}`); + navigate('/' + generatePath(ROUTES.SEARCH, { query: suggestion })); setIsFocused(false); }; const handleSearch = () => { if (!data.trim()) return; - navigate(`/search/${encodeURIComponent(data)}`); + navigate('/' + generatePath(ROUTES.SEARCH, { query: data })); setIsFocused(false); };Also applies to: 111-116
31-41: Avoid repeated cluster fetches; add cache/staleTime.Navbar and SearchImages both fetch clusters. Add a reasonable
staleTimeto reduce network churn.const { data: clustersData, isSuccess: clustersSuccess } = usePictoQuery({ queryKey: ['clusters'], queryFn: fetchAllClusters, + staleTime: 5 * 60 * 1000, // 5 minutes });
135-139: Use SPA navigation (Link) instead of anchor tags.Avoid full reloads; use
<Link>ornavigate.- <a href="/" className="flex items-center space-x-2"> + <a href="/" className="flex items-center space-x-2" onClick={(e) => { e.preventDefault(); navigate(`/${ROUTES.HOME}`); }}> ... - <a href="/settings" className="p-2"> + <a href="/settings" className="p-2" onClick={(e) => { e.preventDefault(); navigate(`/${ROUTES.SETTINGS}`); }}>Alternatively, use <Link to={
/${ROUTES.HOME}}> and <Link to={/${ROUTES.SETTINGS}}>.Also applies to: 204-211
344-350: Copy update: message can be misleading.Suggestions include face names too. Consider “No matches found” instead of “No matching dates found.”
frontend/src/pages/SearchImages/SearchImages.tsx (2)
37-41: De-duplicate clusters fetching or cache it.Navbar already fetches clusters. Add
staleTimeor rely on Navbar data to avoid repeated calls.const { data: clustersData, isSuccess: clustersSuccess } = usePictoQuery({ queryKey: ['clusters'], queryFn: fetchAllClusters, + staleTime: 5 * 60 * 1000, });Also applies to: 60-65
52-56: Optional: use generatePath for person navigation.Avoid hard-coded strings and centralize route building.
+ import { generatePath } from 'react-router'; if (matchedCluster) { - navigate(`/person/${matchedCluster.cluster_id}`); + navigate('/' + generatePath(ROUTES.PERSON, { clusterId: matchedCluster.cluster_id })); return; }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
docs/backend/backend_python/openapi.json(1 hunks)frontend/src/components/Navigation/Navbar/Navbar.tsx(2 hunks)frontend/src/constants/routes.ts(1 hunks)frontend/src/pages/Home/Home.tsx(1 hunks)frontend/src/pages/PersonImages/PersonImages.tsx(1 hunks)frontend/src/pages/SearchImages/SearchImages.tsx(1 hunks)frontend/src/routes/AppRoutes.tsx(2 hunks)
🧰 Additional context used
🧬 Code graph analysis (3)
frontend/src/components/Navigation/Navbar/Navbar.tsx (7)
frontend/src/features/onboardingSelectors.ts (2)
selectName(15-15)selectAvatar(13-13)frontend/src/app/store.ts (1)
RootState(22-22)frontend/src/hooks/useQueryExtension.ts (1)
usePictoQuery(80-108)frontend/src/api/api-functions/face_clusters.ts (1)
fetchAllClusters(18-23)frontend/src/types/Media.ts (1)
Cluster(54-59)frontend/src/features/searchSlice.ts (1)
clearSearch(27-31)frontend/src/components/Dialog/FaceSearchDialog.tsx (1)
FaceSearchDialog(22-127)
frontend/src/routes/AppRoutes.tsx (2)
frontend/src/constants/routes.ts (1)
ROUTES(1-12)frontend/src/pages/SearchImages/SearchImages.tsx (1)
SearchImages(20-172)
frontend/src/pages/SearchImages/SearchImages.tsx (12)
frontend/src/features/imageSelectors.ts (2)
selectIsImageViewOpen(24-27)selectImages(5-7)frontend/src/app/store.ts (1)
RootState(22-22)frontend/src/hooks/useQueryExtension.ts (1)
usePictoQuery(80-108)frontend/src/api/api-functions/face_clusters.ts (1)
fetchAllClusters(18-23)frontend/src/types/Media.ts (2)
Cluster(54-59)Image(13-22)frontend/src/api/api-functions/images.ts (1)
fetchAllImages(5-10)frontend/src/features/loaderSlice.ts (2)
showLoader(17-20)hideLoader(21-24)frontend/src/features/infoDialogSlice.ts (1)
showInfoDialog(16-30)frontend/src/features/imageSlice.ts (1)
setImages(22-26)frontend/src/constants/routes.ts (1)
ROUTES(1-12)frontend/src/components/Media/ImageCard.tsx (1)
ImageCard(20-111)frontend/src/components/Media/MediaView.tsx (1)
MediaView(26-192)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Backend Tests
- GitHub Check: Tauri Build Check (ubuntu-22.04)
🔇 Additional comments (2)
frontend/src/constants/routes.ts (1)
11-11: Route addition looks good.Param name matches consumer (
useParams().query). No concerns.frontend/src/routes/AppRoutes.tsx (1)
11-12: Route wiring looks correct.SearchImages is imported and routed at
ROUTES.SEARCHunder Layout. No issues.Also applies to: 25-25
| useEffect(() => { | ||
| const handleKeyDown = (e: KeyboardEvent) => { | ||
| if (e.key === 'Escape') setIsFocused(false); | ||
| if (e.key === 'Enter' && isFocused && data.trim()) { | ||
| handleSearch(); | ||
| } | ||
| }; | ||
| window.addEventListener('keydown', handleKeyDown); | ||
| return () => window.removeEventListener('keydown', handleKeyDown); | ||
| }, [data, isFocused]); |
There was a problem hiding this comment.
Enter triggers search twice (global + input).
Both window keydown (Line 51-53) and input onKeyDown (Line 175-177) fire, causing duplicate navigations/history entries. Keep one (prefer input handler) and retain global Escape only.
useEffect(() => {
const handleKeyDown = (e: KeyboardEvent) => {
if (e.key === 'Escape') setIsFocused(false);
- if (e.key === 'Enter' && isFocused && data.trim()) {
- handleSearch();
- }
};
window.addEventListener('keydown', handleKeyDown);
return () => window.removeEventListener('keydown', handleKeyDown);
}, [data, isFocused]);Also applies to: 175-177
🤖 Prompt for AI Agents
In frontend/src/components/Navigation/Navbar/Navbar.tsx around lines 48-57 (and
note related input handler at 175-177), the global keydown handler currently
reacts to both Escape and Enter causing duplicate search triggers; update the
useEffect to only listen for Escape (remove the Enter branch) so Enter is
handled exclusively by the input's onKeyDown, keep the existing
addEventListener/removeEventListener and dependency array intact, and verify the
input onKeyDown (lines 175-177) remains as the single place that calls
handleSearch.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
frontend/src/pages/SearchImages/SearchImages.tsx (2)
90-94: Parse response robustly: support both Image[] and { images: Image[] }.This path can break when API returns
{ images: [...] }(not a bare array). Already flagged previously.Apply this diff:
- } else if (isSuccess) { - const images = data?.data as Image[]; - dispatch(setImages(images)); - dispatch(hideLoader()); - } + } else if (isSuccess) { + const res: any = data?.data; + const resolvedImages = (Array.isArray(res) ? res : res?.images || []) as Image[]; + dispatch(setImages(resolvedImages)); + dispatch(hideLoader()); + }Based on snippets (PersonImages uses
res?.images).
105-115: Guard invalid/missing dates in month filter.Missing checks can yield invalid dates and mismatches. Already noted previously.
Apply this diff:
- return images.filter((img) => { - if (!img.metadata?.date_created) return false; - - const dateCreated = new Date(img.metadata.date_created); - const imgMonthYear = dateCreated.toLocaleDateString('en-US', { - month: 'long', - year: 'numeric', - }); - - return imgMonthYear === monthYearString; - }); + return images.filter((img) => { + const ts = img.metadata?.date_created; + if (!ts) return false; + const dateCreated = new Date(ts); + if (Number.isNaN(dateCreated.getTime())) return false; + const imgMonthYear = dateCreated.toLocaleDateString('en-US', { + month: 'long', + year: 'numeric', + }); + return imgMonthYear === monthYearString; + });
🧹 Nitpick comments (4)
frontend/src/pages/SearchImages/SearchImages.tsx (4)
52-55: Build person URL from ROUTES to avoid hard-coded paths.Prevents drift if routes change and keeps consistency.
Apply this diff:
- navigate(`/person/${matchedCluster.cluster_id}`); + navigate(`/${ROUTES.PERSON.replace(':clusterId', matchedCluster.cluster_id)}`);
14-16: Remove leftover inline comments on imports.Keeps code clean.
Apply this diff:
-import { Button } from '@/components/ui/button'; // Add this import -import { ArrowLeft } from 'lucide-react'; // Add this import -import { ROUTES } from '@/constants/routes'; // Add this import +import { Button } from '@/components/ui/button'; +import { ArrowLeft } from 'lucide-react'; +import { ROUTES } from '@/constants/routes';
70-75: Use errorMessage from hook for dialog.Shows actionable error to users.
Apply these diffs:
- const { data, isLoading, isSuccess, isError } = usePictoQuery({ + const { data, isLoading, isSuccess, isError, errorMessage } = usePictoQuery({ queryKey: ['images'], queryFn: fetchAllImages, enabled: !isSearchActive, // Fixed typo here });- showInfoDialog({ + showInfoDialog({ title: 'Error', - message: 'Failed to load images. Please try again later.', + message: errorMessage || 'Failed to load images. Please try again later.', variant: 'error', }),Also applies to: 84-89
60-65: Parse clusters defensively and avoid shadowing
- In SearchImages.tsx, Navbar.tsx and FaceCollections.tsx, handle both array and nested shapes:
const res: any = clustersData?.data; const parsedClusters = Array.isArray(res) ? res : res?.clusters ?? []; dispatch(setClusters(parsedClusters));- Rename the local
clustersvariable toparsedClustersto avoid shadowing the slice reducer.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
frontend/src/pages/SearchImages/SearchImages.tsx(1 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
frontend/src/pages/SearchImages/SearchImages.tsx (9)
frontend/src/features/imageSelectors.ts (2)
selectIsImageViewOpen(24-27)selectImages(5-7)frontend/src/app/store.ts (1)
RootState(22-22)frontend/src/hooks/useQueryExtension.ts (1)
usePictoQuery(80-108)frontend/src/api/api-functions/face_clusters.ts (1)
fetchAllClusters(18-23)frontend/src/types/Media.ts (2)
Cluster(54-59)Image(13-22)frontend/src/api/api-functions/images.ts (1)
fetchAllImages(5-10)frontend/src/constants/routes.ts (1)
ROUTES(1-12)frontend/src/components/Media/ImageCard.tsx (1)
ImageCard(20-111)frontend/src/components/Media/MediaView.tsx (1)
MediaView(26-192)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Tauri Build Check (ubuntu-22.04)
- GitHub Check: Backend Tests
- GitHub Check: Tauri Build Check (windows-latest)
- GitHub Check: Tauri Build Check (macos-latest, --target aarch64-apple-darwin)
| // Format query | ||
| const selectedMonthYear = query | ||
| ? query | ||
| .split(' ') | ||
| .map( | ||
| (word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase(), | ||
| ) | ||
| .join(' ') | ||
| : null; | ||
|
|
||
| const baseImages = isSearchActive ? searchResults : images; | ||
| const displayImages = filterImagesByMonthYear(baseImages, selectedMonthYear); | ||
|
|
||
| const title = selectedMonthYear | ||
| ? `${selectedMonthYear} (${displayImages.length} images)` | ||
| : isSearchActive && searchResults.length > 0 | ||
| ? `Face Search Results (${searchResults.length} found)` | ||
| : 'All Images'; |
There was a problem hiding this comment.
Don’t apply month-year filter to face-name queries (face results get wiped).
Current code treats any query (e.g., "John") as a month-year and filters everything out. Guard with an explicit month-year check and only filter when it matches.
Apply this diff:
- // Format query
- const selectedMonthYear = query
- ? query
- .split(' ')
- .map(
- (word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase(),
- )
- .join(' ')
- : null;
-
- const baseImages = isSearchActive ? searchResults : images;
- const displayImages = filterImagesByMonthYear(baseImages, selectedMonthYear);
+ // Month-Year handling (only when the query is a valid "Month YYYY")
+ const toTitleCase = (s: string) =>
+ s
+ .trim()
+ .split(/\s+/)
+ .map((w) => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())
+ .join(' ');
+ const isMonthYearQuery = (q: string) => {
+ const m = q.trim().match(/^([A-Za-z]+)\s+(\d{4})$/);
+ if (!m) return false;
+ const month = toTitleCase(m[1]);
+ const months = [
+ 'January','February','March','April','May','June',
+ 'July','August','September','October','November','December',
+ ];
+ return months.includes(month);
+ };
+
+ const normalized = query || '';
+ const selectedMonthYear = isMonthYearQuery(normalized) ? toTitleCase(normalized) : null;
+
+ const baseImages = isSearchActive ? searchResults : images;
+ const displayImages = selectedMonthYear
+ ? filterImagesByMonthYear(baseImages, selectedMonthYear)
+ : baseImages;📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // Format query | |
| const selectedMonthYear = query | |
| ? query | |
| .split(' ') | |
| .map( | |
| (word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase(), | |
| ) | |
| .join(' ') | |
| : null; | |
| const baseImages = isSearchActive ? searchResults : images; | |
| const displayImages = filterImagesByMonthYear(baseImages, selectedMonthYear); | |
| const title = selectedMonthYear | |
| ? `${selectedMonthYear} (${displayImages.length} images)` | |
| : isSearchActive && searchResults.length > 0 | |
| ? `Face Search Results (${searchResults.length} found)` | |
| : 'All Images'; | |
| // Month-Year handling (only when the query is a valid "Month YYYY") | |
| const toTitleCase = (s: string) => | |
| s | |
| .trim() | |
| .split(/\s+/) | |
| .map((w) => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase()) | |
| .join(' '); | |
| const isMonthYearQuery = (q: string) => { | |
| const m = q.trim().match(/^([A-Za-z]+)\s+(\d{4})$/); | |
| if (!m) return false; | |
| const month = toTitleCase(m[1]); | |
| const months = [ | |
| 'January','February','March','April','May','June', | |
| 'July','August','September','October','November','December', | |
| ]; | |
| return months.includes(month); | |
| }; | |
| const normalized = query || ''; | |
| const selectedMonthYear = isMonthYearQuery(normalized) | |
| ? toTitleCase(normalized) | |
| : null; | |
| const baseImages = isSearchActive ? searchResults : images; | |
| const displayImages = selectedMonthYear | |
| ? filterImagesByMonthYear(baseImages, selectedMonthYear) | |
| : baseImages; |
🤖 Prompt for AI Agents
In frontend/src/pages/SearchImages/SearchImages.tsx around lines 118 to 135, the
code currently treats any non-empty query as a month-year and calls
filterImagesByMonthYear, which wipes face-name search results; change the
selectedMonthYear logic to only set a value when the query explicitly matches a
month-year pattern (e.g., /^[A-Za-z]+\s+\d{4}$/ or a stricter month name list),
otherwise set selectedMonthYear to null so face-name queries bypass the month
filter; keep the existing baseImages/displayImages/title flow unchanged so
searches for names use searchResults unfiltered.
|
@rahulharpal1603 sir please review this |
|
@Vaibhaviitian Please resolve the conflicts. |
done sir |
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/backend/backend_python/openapi.json(2 hunks)frontend/src/components/Media/MediaView.tsx(2 hunks)frontend/src/pages/PersonImages/PersonImages.tsx(1 hunks)
🔇 Additional comments (2)
docs/backend/backend_python/openapi.json (2)
2155-2166: Approve metadata schema flexibility enhancement.Line 2158 adds
"additionalProperties": trueto theImageInCluster.metadataobject, enabling flexible metadata structures and allowing backend code to include custom fields beyond the strict schema. This is a sensible refactor for extensibility.
1081-1083: ---Fix OpenAPI 3.1.0 specification violation: wrap
$refinallOfto include sibling properties.Lines 1081–1083 place
descriptionanddefaultproperties as siblings to$ref. OpenAPI 3.1.0 disallows sibling properties alongside$ref; tooling ignores them, causing metadata loss. Wrap the reference inallOf:"schema": { + "allOf": [ - "$ref": "#/components/schemas/InputType", + { "$ref": "#/components/schemas/InputType" } + ], "description": "Choose input type: 'path' or 'base64'", "default": "path" },Likely an incorrect or invalid review comment.
| import { useState, useCallback, useMemo, useRef } from 'react'; | ||
| import { useSelector, useDispatch } from 'react-redux'; | ||
| import { revealItemInDir } from '@tauri-apps/plugin-opener'; | ||
| // import { revealItemInDir } from '@tauri-apps/plugin-opener'; |
There was a problem hiding this comment.
Dead code and misleading UX: folder reveal disabled but UI button remains functional.
The folder reveal feature has been disabled by commenting out the import (line 3) and function call (line 80), but the function is still wired to the UI via onOpenFolder (line 146). This creates two issues:
- Dead error handling: The try block is now empty, so the catch block at lines 81-84 can never execute. The error logging is unreachable.
- Misleading UX: Users can still trigger
handleOpenFolderfrom the UI, but it silently does nothing.
Consider one of these approaches:
- Option 1 (preferred): Remove or disable the folder-open button in
MediaViewControlsto match the disabled functionality. - Option 2: Replace the commented code with a user-facing message or toast notification explaining the feature is unavailable.
- Option 3: If this is temporary, add a TODO comment explaining when/why it will be restored.
Apply this diff to remove the dead error handling:
const handleOpenFolder = async () => {
if (!currentImage?.path) return;
- try {
- // await revealItemInDir(currentImage.path);
- } catch (err) {
- console.log(err);
- console.error('Failed to open folder.');
- }
+ // TODO: Restore folder reveal functionality
+ // await revealItemInDir(currentImage.path);
};Alternatively, if the button should be hidden, update MediaViewControls usage or pass a flag to conditionally hide it.
Also applies to: 77-85
🤖 Prompt for AI Agents
frontend/src/components/Media/MediaView.tsx lines 3, 77-85 and ~146: the
revealItemInDir import and its invocation were commented out leaving an empty
try/catch and a still-active UI hook (onOpenFolder) that causes dead error
handling and a misleading button; either remove the button wiring or re-enable
user feedback. Preferred fix: remove the onOpenFolder prop (or pass a
hideOpenFolder boolean) when rendering MediaViewControls so the folder-open
button is hidden, and delete the now-empty try/catch block (lines ~77-85).
Alternatively, if you want visible feedback instead, restore a user-facing
fallback (e.g., show a toast indicating "Open folder unavailable") inside
handleOpenFolder and keep the UI enabled; if this is temporary, add a TODO
comment noting why the feature is disabled and when it will be restored.
| setClusterName(res?.cluster_name || 'random_name'); | ||
| dispatch(hideLoader()); | ||
| } | ||
| console.log(images); |
There was a problem hiding this comment.
Remove debug logging statement.
This console.log logs the Redux state (from line 22) on every effect execution, including during loading and error states. It does not log the freshly fetched data from line 42, as that images variable is scoped only within the isSuccess block.
Since Redux updates are asynchronous, this log will show the previous state, not the newly dispatched data, making it ineffective for debugging the fetch operation.
Apply this diff to remove the debug statement:
dispatch(hideLoader());
}
- console.log(images);
}, [data, isSuccess, isError, isLoading, dispatch]);If you need to debug the fetched data, log the local images variable or res object inside the isSuccess block instead.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| console.log(images); | |
| } | |
| }, [data, isSuccess, isError, isLoading, dispatch]); |
🤖 Prompt for AI Agents
In frontend/src/pages/PersonImages/PersonImages.tsx around line 47, remove the
stray debug console.log(images) which logs stale Redux state on every effect
run; instead, delete that statement and if needed log the freshly fetched data
inside the isSuccess block (e.g., log the local images or res there) so
debugging reflects the current fetch result.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
frontend/src/components/Navigation/Navbar/Navbar.tsx (1)
48-53: Remove the global Enter handler to stop duplicate searches.The window-level keydown still calls
handleSearchon Enter, while the input’sonKeyDowndoes the same. This fires navigation twice (two history entries, double fetch). Keep Escape on the window listener and let the input handle Enter.const handleKeyDown = (e: KeyboardEvent) => { if (e.key === 'Escape') setIsFocused(false); - if (e.key === 'Enter' && isFocused && data.trim()) { - handleSearch(); - } };
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
frontend/src/components/Media/ChronologicalGallery.tsx(1 hunks)frontend/src/components/Navigation/Navbar/Navbar.tsx(1 hunks)frontend/src/features/searchSlice.ts(1 hunks)frontend/src/pages/SearchImages/SearchImages.tsx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- frontend/src/pages/SearchImages/SearchImages.tsx
🧰 Additional context used
🧬 Code graph analysis (2)
frontend/src/features/searchSlice.ts (1)
frontend/src/types/Media.ts (1)
Image(13-22)
frontend/src/components/Navigation/Navbar/Navbar.tsx (7)
frontend/src/features/onboardingSelectors.ts (2)
selectName(15-15)selectAvatar(13-13)frontend/src/app/store.ts (1)
RootState(22-22)frontend/src/hooks/useQueryExtension.ts (1)
usePictoQuery(80-108)frontend/src/api/api-functions/face_clusters.ts (1)
fetchAllClusters(22-27)frontend/src/types/Media.ts (1)
Cluster(51-56)frontend/src/features/searchSlice.ts (1)
clearSearch(24-27)frontend/src/components/Dialog/FaceSearchDialog.tsx (1)
FaceSearchDialog(25-153)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Tauri Build Check (windows-latest)
- GitHub Check: Tauri Build Check (ubuntu-22.04)
- GitHub Check: Backend Tests
- GitHub Check: Tauri Build Check (macos-latest, --target aarch64-apple-darwin)
…to feat/search_functionality
There was a problem hiding this comment.
Actionable comments posted: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (5)
frontend/src/pages/SettingsPage/components/ApplicationControlsCard.tsx (1)
123-123: Description text is now inconsistent with available controls.The description still mentions "server operations" but the Restart Server button has been removed. Update the text to reflect the current functionality.
Proposed fix
- description="Manage updates, server operations, and face clustering" + description="Manage updates and face clustering"sync-microservice/app/core/lifespan.py (1)
3-57: Useasyncio.sleep()instead oftime.sleep()to avoid blocking the event loop during async startup.The
time.sleep()call on line 57 blocks the entire event loop in an async context, preventing other async operations from executing during database retry attempts. Replace withasyncio.sleep(), and usetime.monotonic()for elapsed time tracking (immune to system clock adjustments).✅ Proposed fix
from contextlib import asynccontextmanager from fastapi import FastAPI import time +import asyncio from app.database.folders import ( db_check_database_connection, ) @@ -31,12 +32,12 @@ async def lifespan(app: FastAPI): logger.info("Checking database connection...") connection_timeout = 60 retry_interval = 5 - start_time = time.time() + start_time = time.monotonic() attempt = 0 while True: attempt += 1 - elapsed_time = time.time() - start_time + elapsed_time = time.monotonic() - start_time if db_check_database_connection(): logger.info(f"Database connection successful on attempt {attempt}") @@ -54,7 +55,7 @@ async def lifespan(app: FastAPI): logger.warning( f"Database connection attempt {attempt} failed. Retrying in {retry_interval} seconds... ({elapsed_time:.1f}s elapsed)" ) - time.sleep(retry_interval) + await asyncio.sleep(retry_interval)frontend/src-tauri/capabilities/migrated.json (1)
95-131: Fix spawn command paths to account for PyInstaller onedir structure.The command names and binary names are correctly registered, but the executable paths in the shell spawn commands don't match the actual directory structure created by PyInstaller's
--onediroption.Issue: PyInstaller builds with
--onedircreate nested directory structures (e.g.,dist/PictoPy_Server/PictoPy_Server), but the migrated.json commands attempt to execute./PictoPy_Serverdirectly. After bundling intoresources/backend/andresources/sync-microservice/, the executables are at:
resources/backend/PictoPy_Server/PictoPy_Server(notresources/backend/PictoPy_Server)resources/sync-microservice/PictoPy_Sync/PictoPy_Sync(notresources/sync-microservice/PictoPy_Sync)Update the command args to reference the correct nested paths, or verify the bundling strategy produces a flat structure.
docs/Script_Setup_Guide.md (1)
49-83: Avoid duplicate “Windows/Linux” headings to satisfy MD024.
Markdownlint flags duplicate headings. Consider making these headings unique per section (e.g., “Windows (Backend)” vs “Windows (Sync-Microservice)”).📝 Suggested edit
- #### Windows + #### Windows (Backend) ... - #### Linux + #### Linux (Backend) ... - #### Windows + #### Windows (Sync-Microservice) ... - #### Linux + #### Linux (Sync-Microservice)frontend/src/main.tsx (1)
6-22: Server shutdown removed on close; no stop mechanism exists in codebase.The close handler has only a placeholder comment and no actual shutdown logic. Additionally, the proposed fix references a non-existent
stopServerfunction. The backend and sync-service processes spawned instartServer()have no stored references and cannot be terminated on window close, creating a definite orphan process risk.To fix this:
- Store process references (from
backendCommand.spawn()andsyncCommand.spawn()) in a module-scoped variable or state- Create a
stopServer()function that terminates these stored processes- Call
await stopServer()in theonCloseRequestedcallback
🤖 Fix all issues with AI agents
In @.pre-commit-config.yaml:
- Around line 2-3: Update the pinned pre-commit hook versions: change the ruff
pre-commit rev for the repo entry 'https://github.com/astral-sh/ruff-pre-commit'
from v0.4.10 to v0.14.14, and update the Black hook rev (the
'https://github.com/psf/black' repo entry currently pinned to 24.4.2) to 26.1.0;
ensure you run pre-commit autoupdate or adjust other hook entries consistently
and verify the YAML remains valid after updating the 'rev:' values.
In `@docs/backend/backend_rust/api.md`:
- Around line 17-19: The example has a variable name mismatch: the result of
invoke("get_resources_folder_path") is assigned to resourcesFolderPath but the
log prints serverPath (undefined); update the console.log to reference
resourcesFolderPath (or rename the const to serverPath consistently) so the
logged variable matches the declared identifier (reference: resourcesFolderPath
and invoke("get_resources_folder_path") vs serverPath).
In `@docs/Manual_Setup_Guide.md`:
- Around line 78-104: Update all fenced code blocks that show shell commands
(e.g., the blocks containing "conda create -p .env python=3.12", "conda activate
./.env", "pip install -r requirements.txt", and "fastapi dev --port 52123") to
include the appropriate language tag (use "bash" for Bash examples and
"powershell" where a PowerShell example is intended) so markdownlint MD040 is
satisfied; ensure every triple-backtick fence before and after those command
examples is labeled (e.g., ```bash) and apply the same change to the other
affected section noted (lines around 118-152).
In `@LICENSE.md`:
- Around line 1-595: The PR mixes an unrelated LICENSE.md addition with the Face
Search feature (face names, dates, events, auto-redirect); remove LICENSE.md
from this branch and put it into a dedicated licensing PR: revert or remove the
LICENSE.md file from the current commit (or create a new commit that deletes
LICENSE.md), push the branch update, then create a new branch/PR that adds
LICENSE.md (with an explanatory commit message) so the Face Search changes
remain focused and reviewable.
In `@scripts/setup.ps1`:
- Around line 153-173: The catch block currently logs the error but allows the
script to continue; update the catch so that after Write-Host and restoring the
working directory with Set-Location $PSScriptRoot it terminates the script with
a non‑zero exit (e.g., call exit 1 or throw) to fail fast; adjust the catch
surrounding the try/catch block that contains the virtualenv creation/activation
and use the existing symbols (try, catch, Write-Host, Set-Location
$PSScriptRoot) and add an exit 1 (or throw) to stop further execution when the
sync-microservice setup fails.
In `@scripts/setup.sh`:
- Around line 102-110: Guard the cd sync-microservice step by first checking
that the directory exists (test -d "sync-microservice") and if not, log an error
and exit; then perform cd, create the virtualenv .sync-env, activate it, install
pip and requirements, deactivate and cd .. only when the directory change
succeeded. Update the block around the cd sync-microservice, .sync-env creation
and deactivate to fail fast if the directory is missing or cd fails, so the pip
install -r requirements.txt does not run in the wrong location.
🧹 Nitpick comments (10)
frontend/src/pages/SettingsPage/components/ApplicationControlsCard.tsx (1)
125-125: Grid layout specifies 3 columns but only 2 buttons remain.With the Restart Server button removed,
md:grid-cols-3leaves unbalanced spacing. Consider adjusting to 2 columns.Proposed fix
- <div className="grid grid-cols-1 gap-4 md:grid-cols-3"> + <div className="grid grid-cols-1 gap-4 md:grid-cols-2">docs/stylesheets/extra.css (1)
32-41: Minor redundancy with parent rules.These heading rules duplicate the same
overflow-wrapandword-breakproperties already set on.md-typeset(lines 26-30). In standard CSS, headings would inherit these values. However, this explicit declaration is acceptable as a defensive measure in case the MkDocs Material theme sets conflicting styles on headings.LICENSE.md (1)
5-5: HTML entities in URLs should use plain characters.Lines 5, 588, and 595 use HTML entities (
<and>) instead of plain angle brackets. In Markdown, these should be rendered as plain characters for better readability.📝 Suggested formatting improvements
Line 5:
-_Copyright © 2007 Free Software Foundation, Inc. <<http://fsf.org/>>_ +_Copyright © 2007 Free Software Foundation, Inc. <<http://fsf.org/>>_Line 588:
-<<http://www.gnu.org/licenses/>>. +<<http://www.gnu.org/licenses/>>.Line 595:
-<<http://www.gnu.org/philosophy/why-not-lgpl.html>>. +<<http://www.gnu.org/philosophy/why-not-lgpl.html>>.Also applies to: 588-588, 595-595
.github/workflows/build-and-release.yml (1)
322-326: Addmkdir -pfor consistency with other copy operations in the workflow.While the
utilsfolder exists at the repository root and parent directories are created before this step, other similar copy operations throughout the workflow usemkdir -pbeforecp -r(e.g., lines 82-84, 122-124, 203-204). Addingmkdir -phere would follow the established pattern:Suggested improvement
- name: Copy utils folder shell: bash run: | + mkdir -p backend/dist/utils sync-microservice/dist/utils cp -r utils backend/dist/utils cp -r utils sync-microservice/dist/utilsapp.py (1)
14-18: Group cache keys for easier extension.
Small refactor to reduce duplication and simplify future additions.♻️ Proposed change
def refresh_data(): # ...existing code... # Clear specific caches that need refreshing - invalidate_cache("albums:get_all_albums") - invalidate_cache("folder_structure:get_folder_structure") + for key in ("albums:get_all_albums", "folder_structure:get_folder_structure"): + invalidate_cache(key) # ...existing code...docs/backend/backend_python/openapi.json (1)
1116-1124: OpenAPI 3.1 allows$refwith sibling keywords in Schema Objects—current code is spec-compliant.Your schema is valid per OpenAPI 3.1 spec. The
$refwithdescriptionanddefaultsiblings are explicitly allowed in Schema Objects and should be processed together by compliant tooling (Swagger UI, OpenAPI Generator). If you need to support older tooling that predates 3.1 support, theallOfwrapper is a defensive measure, but it's not required by the specification itself.frontend/src/config/Backend.ts (1)
1-2: LGTM!Port changes are consistent with the backend configuration updates. The removal of
/api/v1fromSYNC_MICROSERVICE_URLaligns with the sync-microservice settings.Consider using environment variables or a configuration mechanism for these URLs to support different deployment environments (development, staging, production) without code changes.
backend/main.py (1)
73-73: Consider making host/port configurable to avoid local-only lock-in.Hardcoding
localhost:52123changes deployment semantics; if the backend ever needs to be reachable beyond localhost, this will block it. A simple env override keeps local defaults while enabling other setups.🔧 Suggested tweak (env-configurable host/port)
- servers=[ - {"url": "http://localhost:52123", "description": "Local Development server"} - ], + servers=[ + { + "url": f"http://{os.environ.get('PICTOPY_HOST','localhost')}:{os.environ.get('PICTOPY_PORT','52123')}", + "description": "Local Development server", + } + ], @@ - host="localhost", - port=52123, + host=os.environ.get("PICTOPY_HOST", "localhost"), + port=int(os.environ.get("PICTOPY_PORT", "52123")),Also applies to: 144-145
frontend/src/utils/serverUtils.ts (1)
36-72: Use an explicit args array when creating Tauri commands.Passing
''as args can be interpreted as a single empty argument; using[]avoids platform-specific quirks with@tauri-apps/plugin-shell.🔧 Proposed adjustment
- const backendCommand = Command.create( - isWindows() ? 'StartBackendWindows' : 'StartBackendUnix', - '', - { cwd: resourcesFolderPath + '/backend' }, - ); + const backendCommand = Command.create( + isWindows() ? 'StartBackendWindows' : 'StartBackendUnix', + [], + { cwd: resourcesFolderPath + '/backend' }, + ); @@ - const syncCommand = Command.create( - isWindows() ? 'StartSyncServiceWindows' : 'StartSyncServiceUnix', - '', - { cwd: resourcesFolderPath + '/sync-microservice' }, - ); + const syncCommand = Command.create( + isWindows() ? 'StartSyncServiceWindows' : 'StartSyncServiceUnix', + [], + { cwd: resourcesFolderPath + '/sync-microservice' }, + );frontend/src/components/OnboardingSteps/ServerCheck.tsx (1)
23-36: Consider making the 60× retry window configurable to avoid long stalls.
Withretry: 60andretryDelay: 1000, onboarding can wait ~60s before surfacing a failure. Consider pulling these into a config/env constant or using a capped backoff to keep the UX responsive.
| - repo: https://github.com/astral-sh/ruff-pre-commit | ||
| rev: v0.4.10 |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
latest release astral-sh ruff-pre-commit 2025 2026
💡 Result:
As of January 25, 2026, the latest astral-sh/ruff-pre-commit release is v0.14.14, released January 22, 2026. [1]
If you specifically mean the latest release that happened in 2025, it was v0.14.10, released December 18, 2025. [1]
🌐 Web query:
latest stable release Black formatter Python 2025 2026
💡 Result:
- Latest stable Black release (as of Jan 25, 2026):
26.1.0, released Jan 18, 2026. (pypi.org) - Key 2025-era stable-style milestone:
25.1.0(introduces the “2025 stable style”). (pypi.org)
Citations:
Update pre-commit hook versions to current releases.
The pinned versions are significantly outdated:
- ruff-pre-commit: v0.4.10 (pinned) → v0.14.14 (current, Jan 2026) — 10 minor versions behind
- black: 24.4.2 (pinned) → 26.1.0 (current, Jan 2026) — 2 major versions behind
These gaps likely include critical fixes, performance improvements, and behavior changes. Update to the latest versions.
Also applies to: 9-9
🤖 Prompt for AI Agents
In @.pre-commit-config.yaml around lines 2 - 3, Update the pinned pre-commit
hook versions: change the ruff pre-commit rev for the repo entry
'https://github.com/astral-sh/ruff-pre-commit' from v0.4.10 to v0.14.14, and
update the Black hook rev (the 'https://github.com/psf/black' repo entry
currently pinned to 24.4.2) to 26.1.0; ensure you run pre-commit autoupdate or
adjust other hook entries consistently and verify the YAML remains valid after
updating the 'rev:' values.
| // Example: Get server path | ||
| const serverPath = await invoke("get_server_path"); | ||
| console.log("Server path:", serverPath); | ||
| const resourcesFolderPath = await invoke("get_resources_folder_path"); | ||
| console.log("Resources folder path:", serverPath); |
There was a problem hiding this comment.
Fix the variable name inconsistency in the example.
The variable is declared as resourcesFolderPath on line 18, but line 19 logs serverPath which would be undefined.
📝 Proposed fix
// Example: Get server path
const resourcesFolderPath = await invoke("get_resources_folder_path");
-console.log("Resources folder path:", serverPath);
+console.log("Resources folder path:", resourcesFolderPath);🤖 Prompt for AI Agents
In `@docs/backend/backend_rust/api.md` around lines 17 - 19, The example has a
variable name mismatch: the result of invoke("get_resources_folder_path") is
assigned to resourcesFolderPath but the log prints serverPath (undefined);
update the console.log to reference resourcesFolderPath (or rename the const to
serverPath consistently) so the logged variable matches the declared identifier
(reference: resourcesFolderPath and invoke("get_resources_folder_path") vs
serverPath).
| ``` | ||
| python3 -m venv .env | ||
| conda create -p .env python=3.12 | ||
| ``` | ||
|
|
||
| Powershell(Windows) | ||
| 3. **Activate the Conda Environment:** | ||
|
|
||
| Bash/Powershell | ||
|
|
||
| ``` | ||
| python -m venv .env | ||
| conda activate ./.env | ||
| ``` | ||
|
|
||
| 3. **Activate the Virtual Environment:** | ||
| 4. **Install Dependencies:** The `requirements.txt` file lists required packages. Install them using pip: | ||
|
|
||
| Bash(Linux/MacOS) | ||
| Bash/Powershell | ||
|
|
||
| ``` | ||
| source .env/bin/activate | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| Powershell(Windows) | ||
| 5. **Running the backend:**: To start the backend in development mode, run this command while being in the backend folder and the conda environment activated: | ||
|
|
||
| Bash/Powershell | ||
|
|
||
| ``` | ||
| .env\Scripts\activate.ps1 | ||
| fastapi dev --port 52123 | ||
| ``` |
There was a problem hiding this comment.
Add language identifiers to fenced code blocks (MD040).
Several fenced blocks are missing a language tag; markdownlint will flag these. Please add bash (or powershell where appropriate) to all updated code fences.
📝 Example fix (apply to all relevant fences)
- ```
+ ```bash
conda create -p .env python=3.12
```
...
- ```
+ ```bash
fastapi dev --port 52123
```Also applies to: 118-152
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
78-78: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
86-86: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
94-94: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
102-102: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@docs/Manual_Setup_Guide.md` around lines 78 - 104, Update all fenced code
blocks that show shell commands (e.g., the blocks containing "conda create -p
.env python=3.12", "conda activate ./.env", "pip install -r requirements.txt",
and "fastapi dev --port 52123") to include the appropriate language tag (use
"bash" for Bash examples and "powershell" where a PowerShell example is
intended) so markdownlint MD040 is satisfied; ensure every triple-backtick fence
before and after those command examples is labeled (e.g., ```bash) and apply the
same change to the other affected section noted (lines around 118-152).
| GNU General Public License | ||
| ========================== | ||
|
|
||
| _Version 3, 29 June 2007_ | ||
| _Copyright © 2007 Free Software Foundation, Inc. <<http://fsf.org/>>_ | ||
|
|
||
| Everyone is permitted to copy and distribute verbatim copies of this license | ||
| document, but changing it is not allowed. | ||
|
|
||
| ## Preamble | ||
|
|
||
| The GNU General Public License is a free, copyleft license for software and other | ||
| kinds of works. | ||
|
|
||
| The licenses for most software and other practical works are designed to take away | ||
| your freedom to share and change the works. By contrast, the GNU General Public | ||
| License is intended to guarantee your freedom to share and change all versions of a | ||
| program--to make sure it remains free software for all its users. We, the Free | ||
| Software Foundation, use the GNU General Public License for most of our software; it | ||
| applies also to any other work released this way by its authors. You can apply it to | ||
| your programs, too. | ||
|
|
||
| When we speak of free software, we are referring to freedom, not price. Our General | ||
| Public Licenses are designed to make sure that you have the freedom to distribute | ||
| copies of free software (and charge for them if you wish), that you receive source | ||
| code or can get it if you want it, that you can change the software or use pieces of | ||
| it in new free programs, and that you know you can do these things. | ||
|
|
||
| To protect your rights, we need to prevent others from denying you these rights or | ||
| asking you to surrender the rights. Therefore, you have certain responsibilities if | ||
| you distribute copies of the software, or if you modify it: responsibilities to | ||
| respect the freedom of others. | ||
|
|
||
| For example, if you distribute copies of such a program, whether gratis or for a fee, | ||
| you must pass on to the recipients the same freedoms that you received. You must make | ||
| sure that they, too, receive or can get the source code. And you must show them these | ||
| terms so they know their rights. | ||
|
|
||
| Developers that use the GNU GPL protect your rights with two steps: **(1)** assert | ||
| copyright on the software, and **(2)** offer you this License giving you legal permission | ||
| to copy, distribute and/or modify it. | ||
|
|
||
| For the developers' and authors' protection, the GPL clearly explains that there is | ||
| no warranty for this free software. For both users' and authors' sake, the GPL | ||
| requires that modified versions be marked as changed, so that their problems will not | ||
| be attributed erroneously to authors of previous versions. | ||
|
|
||
| Some devices are designed to deny users access to install or run modified versions of | ||
| the software inside them, although the manufacturer can do so. This is fundamentally | ||
| incompatible with the aim of protecting users' freedom to change the software. The | ||
| systematic pattern of such abuse occurs in the area of products for individuals to | ||
| use, which is precisely where it is most unacceptable. Therefore, we have designed | ||
| this version of the GPL to prohibit the practice for those products. If such problems | ||
| arise substantially in other domains, we stand ready to extend this provision to | ||
| those domains in future versions of the GPL, as needed to protect the freedom of | ||
| users. | ||
|
|
||
| Finally, every program is threatened constantly by software patents. States should | ||
| not allow patents to restrict development and use of software on general-purpose | ||
| computers, but in those that do, we wish to avoid the special danger that patents | ||
| applied to a free program could make it effectively proprietary. To prevent this, the | ||
| GPL assures that patents cannot be used to render the program non-free. | ||
|
|
||
| The precise terms and conditions for copying, distribution and modification follow. | ||
|
|
||
| ## TERMS AND CONDITIONS | ||
|
|
||
| ### 0. Definitions | ||
|
|
||
| “This License” refers to version 3 of the GNU General Public License. | ||
|
|
||
| “Copyright” also means copyright-like laws that apply to other kinds of | ||
| works, such as semiconductor masks. | ||
|
|
||
| “The Program” refers to any copyrightable work licensed under this | ||
| License. Each licensee is addressed as “you”. “Licensees” and | ||
| “recipients” may be individuals or organizations. | ||
|
|
||
| To “modify” a work means to copy from or adapt all or part of the work in | ||
| a fashion requiring copyright permission, other than the making of an exact copy. The | ||
| resulting work is called a “modified version” of the earlier work or a | ||
| work “based on” the earlier work. | ||
|
|
||
| A “covered work” means either the unmodified Program or a work based on | ||
| the Program. | ||
|
|
||
| To “propagate” a work means to do anything with it that, without | ||
| permission, would make you directly or secondarily liable for infringement under | ||
| applicable copyright law, except executing it on a computer or modifying a private | ||
| copy. Propagation includes copying, distribution (with or without modification), | ||
| making available to the public, and in some countries other activities as well. | ||
|
|
||
| To “convey” a work means any kind of propagation that enables other | ||
| parties to make or receive copies. Mere interaction with a user through a computer | ||
| network, with no transfer of a copy, is not conveying. | ||
|
|
||
| An interactive user interface displays “Appropriate Legal Notices” to the | ||
| extent that it includes a convenient and prominently visible feature that **(1)** | ||
| displays an appropriate copyright notice, and **(2)** tells the user that there is no | ||
| warranty for the work (except to the extent that warranties are provided), that | ||
| licensees may convey the work under this License, and how to view a copy of this | ||
| License. If the interface presents a list of user commands or options, such as a | ||
| menu, a prominent item in the list meets this criterion. | ||
|
|
||
| ### 1. Source Code | ||
|
|
||
| The “source code” for a work means the preferred form of the work for | ||
| making modifications to it. “Object code” means any non-source form of a | ||
| work. | ||
|
|
||
| A “Standard Interface” means an interface that either is an official | ||
| standard defined by a recognized standards body, or, in the case of interfaces | ||
| specified for a particular programming language, one that is widely used among | ||
| developers working in that language. | ||
|
|
||
| The “System Libraries” of an executable work include anything, other than | ||
| the work as a whole, that **(a)** is included in the normal form of packaging a Major | ||
| Component, but which is not part of that Major Component, and **(b)** serves only to | ||
| enable use of the work with that Major Component, or to implement a Standard | ||
| Interface for which an implementation is available to the public in source code form. | ||
| A “Major Component”, in this context, means a major essential component | ||
| (kernel, window system, and so on) of the specific operating system (if any) on which | ||
| the executable work runs, or a compiler used to produce the work, or an object code | ||
| interpreter used to run it. | ||
|
|
||
| The “Corresponding Source” for a work in object code form means all the | ||
| source code needed to generate, install, and (for an executable work) run the object | ||
| code and to modify the work, including scripts to control those activities. However, | ||
| it does not include the work's System Libraries, or general-purpose tools or | ||
| generally available free programs which are used unmodified in performing those | ||
| activities but which are not part of the work. For example, Corresponding Source | ||
| includes interface definition files associated with source files for the work, and | ||
| the source code for shared libraries and dynamically linked subprograms that the work | ||
| is specifically designed to require, such as by intimate data communication or | ||
| control flow between those subprograms and other parts of the work. | ||
|
|
||
| The Corresponding Source need not include anything that users can regenerate | ||
| automatically from other parts of the Corresponding Source. | ||
|
|
||
| The Corresponding Source for a work in source code form is that same work. | ||
|
|
||
| ### 2. Basic Permissions | ||
|
|
||
| All rights granted under this License are granted for the term of copyright on the | ||
| Program, and are irrevocable provided the stated conditions are met. This License | ||
| explicitly affirms your unlimited permission to run the unmodified Program. The | ||
| output from running a covered work is covered by this License only if the output, | ||
| given its content, constitutes a covered work. This License acknowledges your rights | ||
| of fair use or other equivalent, as provided by copyright law. | ||
|
|
||
| You may make, run and propagate covered works that you do not convey, without | ||
| conditions so long as your license otherwise remains in force. You may convey covered | ||
| works to others for the sole purpose of having them make modifications exclusively | ||
| for you, or provide you with facilities for running those works, provided that you | ||
| comply with the terms of this License in conveying all material for which you do not | ||
| control copyright. Those thus making or running the covered works for you must do so | ||
| exclusively on your behalf, under your direction and control, on terms that prohibit | ||
| them from making any copies of your copyrighted material outside their relationship | ||
| with you. | ||
|
|
||
| Conveying under any other circumstances is permitted solely under the conditions | ||
| stated below. Sublicensing is not allowed; section 10 makes it unnecessary. | ||
|
|
||
| ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law | ||
|
|
||
| No covered work shall be deemed part of an effective technological measure under any | ||
| applicable law fulfilling obligations under article 11 of the WIPO copyright treaty | ||
| adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention | ||
| of such measures. | ||
|
|
||
| When you convey a covered work, you waive any legal power to forbid circumvention of | ||
| technological measures to the extent such circumvention is effected by exercising | ||
| rights under this License with respect to the covered work, and you disclaim any | ||
| intention to limit operation or modification of the work as a means of enforcing, | ||
| against the work's users, your or third parties' legal rights to forbid circumvention | ||
| of technological measures. | ||
|
|
||
| ### 4. Conveying Verbatim Copies | ||
|
|
||
| You may convey verbatim copies of the Program's source code as you receive it, in any | ||
| medium, provided that you conspicuously and appropriately publish on each copy an | ||
| appropriate copyright notice; keep intact all notices stating that this License and | ||
| any non-permissive terms added in accord with section 7 apply to the code; keep | ||
| intact all notices of the absence of any warranty; and give all recipients a copy of | ||
| this License along with the Program. | ||
|
|
||
| You may charge any price or no price for each copy that you convey, and you may offer | ||
| support or warranty protection for a fee. | ||
|
|
||
| ### 5. Conveying Modified Source Versions | ||
|
|
||
| You may convey a work based on the Program, or the modifications to produce it from | ||
| the Program, in the form of source code under the terms of section 4, provided that | ||
| you also meet all of these conditions: | ||
|
|
||
| * **a)** The work must carry prominent notices stating that you modified it, and giving a | ||
| relevant date. | ||
| * **b)** The work must carry prominent notices stating that it is released under this | ||
| License and any conditions added under section 7. This requirement modifies the | ||
| requirement in section 4 to “keep intact all notices”. | ||
| * **c)** You must license the entire work, as a whole, under this License to anyone who | ||
| comes into possession of a copy. This License will therefore apply, along with any | ||
| applicable section 7 additional terms, to the whole of the work, and all its parts, | ||
| regardless of how they are packaged. This License gives no permission to license the | ||
| work in any other way, but it does not invalidate such permission if you have | ||
| separately received it. | ||
| * **d)** If the work has interactive user interfaces, each must display Appropriate Legal | ||
| Notices; however, if the Program has interactive interfaces that do not display | ||
| Appropriate Legal Notices, your work need not make them do so. | ||
|
|
||
| A compilation of a covered work with other separate and independent works, which are | ||
| not by their nature extensions of the covered work, and which are not combined with | ||
| it such as to form a larger program, in or on a volume of a storage or distribution | ||
| medium, is called an “aggregate” if the compilation and its resulting | ||
| copyright are not used to limit the access or legal rights of the compilation's users | ||
| beyond what the individual works permit. Inclusion of a covered work in an aggregate | ||
| does not cause this License to apply to the other parts of the aggregate. | ||
|
|
||
| ### 6. Conveying Non-Source Forms | ||
|
|
||
| You may convey a covered work in object code form under the terms of sections 4 and | ||
| 5, provided that you also convey the machine-readable Corresponding Source under the | ||
| terms of this License, in one of these ways: | ||
|
|
||
| * **a)** Convey the object code in, or embodied in, a physical product (including a | ||
| physical distribution medium), accompanied by the Corresponding Source fixed on a | ||
| durable physical medium customarily used for software interchange. | ||
| * **b)** Convey the object code in, or embodied in, a physical product (including a | ||
| physical distribution medium), accompanied by a written offer, valid for at least | ||
| three years and valid for as long as you offer spare parts or customer support for | ||
| that product model, to give anyone who possesses the object code either **(1)** a copy of | ||
| the Corresponding Source for all the software in the product that is covered by this | ||
| License, on a durable physical medium customarily used for software interchange, for | ||
| a price no more than your reasonable cost of physically performing this conveying of | ||
| source, or **(2)** access to copy the Corresponding Source from a network server at no | ||
| charge. | ||
| * **c)** Convey individual copies of the object code with a copy of the written offer to | ||
| provide the Corresponding Source. This alternative is allowed only occasionally and | ||
| noncommercially, and only if you received the object code with such an offer, in | ||
| accord with subsection 6b. | ||
| * **d)** Convey the object code by offering access from a designated place (gratis or for | ||
| a charge), and offer equivalent access to the Corresponding Source in the same way | ||
| through the same place at no further charge. You need not require recipients to copy | ||
| the Corresponding Source along with the object code. If the place to copy the object | ||
| code is a network server, the Corresponding Source may be on a different server | ||
| (operated by you or a third party) that supports equivalent copying facilities, | ||
| provided you maintain clear directions next to the object code saying where to find | ||
| the Corresponding Source. Regardless of what server hosts the Corresponding Source, | ||
| you remain obligated to ensure that it is available for as long as needed to satisfy | ||
| these requirements. | ||
| * **e)** Convey the object code using peer-to-peer transmission, provided you inform | ||
| other peers where the object code and Corresponding Source of the work are being | ||
| offered to the general public at no charge under subsection 6d. | ||
|
|
||
| A separable portion of the object code, whose source code is excluded from the | ||
| Corresponding Source as a System Library, need not be included in conveying the | ||
| object code work. | ||
|
|
||
| A “User Product” is either **(1)** a “consumer product”, which | ||
| means any tangible personal property which is normally used for personal, family, or | ||
| household purposes, or **(2)** anything designed or sold for incorporation into a | ||
| dwelling. In determining whether a product is a consumer product, doubtful cases | ||
| shall be resolved in favor of coverage. For a particular product received by a | ||
| particular user, “normally used” refers to a typical or common use of | ||
| that class of product, regardless of the status of the particular user or of the way | ||
| in which the particular user actually uses, or expects or is expected to use, the | ||
| product. A product is a consumer product regardless of whether the product has | ||
| substantial commercial, industrial or non-consumer uses, unless such uses represent | ||
| the only significant mode of use of the product. | ||
|
|
||
| “Installation Information” for a User Product means any methods, | ||
| procedures, authorization keys, or other information required to install and execute | ||
| modified versions of a covered work in that User Product from a modified version of | ||
| its Corresponding Source. The information must suffice to ensure that the continued | ||
| functioning of the modified object code is in no case prevented or interfered with | ||
| solely because modification has been made. | ||
|
|
||
| If you convey an object code work under this section in, or with, or specifically for | ||
| use in, a User Product, and the conveying occurs as part of a transaction in which | ||
| the right of possession and use of the User Product is transferred to the recipient | ||
| in perpetuity or for a fixed term (regardless of how the transaction is | ||
| characterized), the Corresponding Source conveyed under this section must be | ||
| accompanied by the Installation Information. But this requirement does not apply if | ||
| neither you nor any third party retains the ability to install modified object code | ||
| on the User Product (for example, the work has been installed in ROM). | ||
|
|
||
| The requirement to provide Installation Information does not include a requirement to | ||
| continue to provide support service, warranty, or updates for a work that has been | ||
| modified or installed by the recipient, or for the User Product in which it has been | ||
| modified or installed. Access to a network may be denied when the modification itself | ||
| materially and adversely affects the operation of the network or violates the rules | ||
| and protocols for communication across the network. | ||
|
|
||
| Corresponding Source conveyed, and Installation Information provided, in accord with | ||
| this section must be in a format that is publicly documented (and with an | ||
| implementation available to the public in source code form), and must require no | ||
| special password or key for unpacking, reading or copying. | ||
|
|
||
| ### 7. Additional Terms | ||
|
|
||
| “Additional permissions” are terms that supplement the terms of this | ||
| License by making exceptions from one or more of its conditions. Additional | ||
| permissions that are applicable to the entire Program shall be treated as though they | ||
| were included in this License, to the extent that they are valid under applicable | ||
| law. If additional permissions apply only to part of the Program, that part may be | ||
| used separately under those permissions, but the entire Program remains governed by | ||
| this License without regard to the additional permissions. | ||
|
|
||
| When you convey a copy of a covered work, you may at your option remove any | ||
| additional permissions from that copy, or from any part of it. (Additional | ||
| permissions may be written to require their own removal in certain cases when you | ||
| modify the work.) You may place additional permissions on material, added by you to a | ||
| covered work, for which you have or can give appropriate copyright permission. | ||
|
|
||
| Notwithstanding any other provision of this License, for material you add to a | ||
| covered work, you may (if authorized by the copyright holders of that material) | ||
| supplement the terms of this License with terms: | ||
|
|
||
| * **a)** Disclaiming warranty or limiting liability differently from the terms of | ||
| sections 15 and 16 of this License; or | ||
| * **b)** Requiring preservation of specified reasonable legal notices or author | ||
| attributions in that material or in the Appropriate Legal Notices displayed by works | ||
| containing it; or | ||
| * **c)** Prohibiting misrepresentation of the origin of that material, or requiring that | ||
| modified versions of such material be marked in reasonable ways as different from the | ||
| original version; or | ||
| * **d)** Limiting the use for publicity purposes of names of licensors or authors of the | ||
| material; or | ||
| * **e)** Declining to grant rights under trademark law for use of some trade names, | ||
| trademarks, or service marks; or | ||
| * **f)** Requiring indemnification of licensors and authors of that material by anyone | ||
| who conveys the material (or modified versions of it) with contractual assumptions of | ||
| liability to the recipient, for any liability that these contractual assumptions | ||
| directly impose on those licensors and authors. | ||
|
|
||
| All other non-permissive additional terms are considered “further | ||
| restrictions” within the meaning of section 10. If the Program as you received | ||
| it, or any part of it, contains a notice stating that it is governed by this License | ||
| along with a term that is a further restriction, you may remove that term. If a | ||
| license document contains a further restriction but permits relicensing or conveying | ||
| under this License, you may add to a covered work material governed by the terms of | ||
| that license document, provided that the further restriction does not survive such | ||
| relicensing or conveying. | ||
|
|
||
| If you add terms to a covered work in accord with this section, you must place, in | ||
| the relevant source files, a statement of the additional terms that apply to those | ||
| files, or a notice indicating where to find the applicable terms. | ||
|
|
||
| Additional terms, permissive or non-permissive, may be stated in the form of a | ||
| separately written license, or stated as exceptions; the above requirements apply | ||
| either way. | ||
|
|
||
| ### 8. Termination | ||
|
|
||
| You may not propagate or modify a covered work except as expressly provided under | ||
| this License. Any attempt otherwise to propagate or modify it is void, and will | ||
| automatically terminate your rights under this License (including any patent licenses | ||
| granted under the third paragraph of section 11). | ||
|
|
||
| However, if you cease all violation of this License, then your license from a | ||
| particular copyright holder is reinstated **(a)** provisionally, unless and until the | ||
| copyright holder explicitly and finally terminates your license, and **(b)** permanently, | ||
| if the copyright holder fails to notify you of the violation by some reasonable means | ||
| prior to 60 days after the cessation. | ||
|
|
||
| Moreover, your license from a particular copyright holder is reinstated permanently | ||
| if the copyright holder notifies you of the violation by some reasonable means, this | ||
| is the first time you have received notice of violation of this License (for any | ||
| work) from that copyright holder, and you cure the violation prior to 30 days after | ||
| your receipt of the notice. | ||
|
|
||
| Termination of your rights under this section does not terminate the licenses of | ||
| parties who have received copies or rights from you under this License. If your | ||
| rights have been terminated and not permanently reinstated, you do not qualify to | ||
| receive new licenses for the same material under section 10. | ||
|
|
||
| ### 9. Acceptance Not Required for Having Copies | ||
|
|
||
| You are not required to accept this License in order to receive or run a copy of the | ||
| Program. Ancillary propagation of a covered work occurring solely as a consequence of | ||
| using peer-to-peer transmission to receive a copy likewise does not require | ||
| acceptance. However, nothing other than this License grants you permission to | ||
| propagate or modify any covered work. These actions infringe copyright if you do not | ||
| accept this License. Therefore, by modifying or propagating a covered work, you | ||
| indicate your acceptance of this License to do so. | ||
|
|
||
| ### 10. Automatic Licensing of Downstream Recipients | ||
|
|
||
| Each time you convey a covered work, the recipient automatically receives a license | ||
| from the original licensors, to run, modify and propagate that work, subject to this | ||
| License. You are not responsible for enforcing compliance by third parties with this | ||
| License. | ||
|
|
||
| An “entity transaction” is a transaction transferring control of an | ||
| organization, or substantially all assets of one, or subdividing an organization, or | ||
| merging organizations. If propagation of a covered work results from an entity | ||
| transaction, each party to that transaction who receives a copy of the work also | ||
| receives whatever licenses to the work the party's predecessor in interest had or | ||
| could give under the previous paragraph, plus a right to possession of the | ||
| Corresponding Source of the work from the predecessor in interest, if the predecessor | ||
| has it or can get it with reasonable efforts. | ||
|
|
||
| You may not impose any further restrictions on the exercise of the rights granted or | ||
| affirmed under this License. For example, you may not impose a license fee, royalty, | ||
| or other charge for exercise of rights granted under this License, and you may not | ||
| initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging | ||
| that any patent claim is infringed by making, using, selling, offering for sale, or | ||
| importing the Program or any portion of it. | ||
|
|
||
| ### 11. Patents | ||
|
|
||
| A “contributor” is a copyright holder who authorizes use under this | ||
| License of the Program or a work on which the Program is based. The work thus | ||
| licensed is called the contributor's “contributor version”. | ||
|
|
||
| A contributor's “essential patent claims” are all patent claims owned or | ||
| controlled by the contributor, whether already acquired or hereafter acquired, that | ||
| would be infringed by some manner, permitted by this License, of making, using, or | ||
| selling its contributor version, but do not include claims that would be infringed | ||
| only as a consequence of further modification of the contributor version. For | ||
| purposes of this definition, “control” includes the right to grant patent | ||
| sublicenses in a manner consistent with the requirements of this License. | ||
|
|
||
| Each contributor grants you a non-exclusive, worldwide, royalty-free patent license | ||
| under the contributor's essential patent claims, to make, use, sell, offer for sale, | ||
| import and otherwise run, modify and propagate the contents of its contributor | ||
| version. | ||
|
|
||
| In the following three paragraphs, a “patent license” is any express | ||
| agreement or commitment, however denominated, not to enforce a patent (such as an | ||
| express permission to practice a patent or covenant not to sue for patent | ||
| infringement). To “grant” such a patent license to a party means to make | ||
| such an agreement or commitment not to enforce a patent against the party. | ||
|
|
||
| If you convey a covered work, knowingly relying on a patent license, and the | ||
| Corresponding Source of the work is not available for anyone to copy, free of charge | ||
| and under the terms of this License, through a publicly available network server or | ||
| other readily accessible means, then you must either **(1)** cause the Corresponding | ||
| Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the | ||
| patent license for this particular work, or **(3)** arrange, in a manner consistent with | ||
| the requirements of this License, to extend the patent license to downstream | ||
| recipients. “Knowingly relying” means you have actual knowledge that, but | ||
| for the patent license, your conveying the covered work in a country, or your | ||
| recipient's use of the covered work in a country, would infringe one or more | ||
| identifiable patents in that country that you have reason to believe are valid. | ||
|
|
||
| If, pursuant to or in connection with a single transaction or arrangement, you | ||
| convey, or propagate by procuring conveyance of, a covered work, and grant a patent | ||
| license to some of the parties receiving the covered work authorizing them to use, | ||
| propagate, modify or convey a specific copy of the covered work, then the patent | ||
| license you grant is automatically extended to all recipients of the covered work and | ||
| works based on it. | ||
|
|
||
| A patent license is “discriminatory” if it does not include within the | ||
| scope of its coverage, prohibits the exercise of, or is conditioned on the | ||
| non-exercise of one or more of the rights that are specifically granted under this | ||
| License. You may not convey a covered work if you are a party to an arrangement with | ||
| a third party that is in the business of distributing software, under which you make | ||
| payment to the third party based on the extent of your activity of conveying the | ||
| work, and under which the third party grants, to any of the parties who would receive | ||
| the covered work from you, a discriminatory patent license **(a)** in connection with | ||
| copies of the covered work conveyed by you (or copies made from those copies), or **(b)** | ||
| primarily for and in connection with specific products or compilations that contain | ||
| the covered work, unless you entered into that arrangement, or that patent license | ||
| was granted, prior to 28 March 2007. | ||
|
|
||
| Nothing in this License shall be construed as excluding or limiting any implied | ||
| license or other defenses to infringement that may otherwise be available to you | ||
| under applicable patent law. | ||
|
|
||
| ### 12. No Surrender of Others' Freedom | ||
|
|
||
| If conditions are imposed on you (whether by court order, agreement or otherwise) | ||
| that contradict the conditions of this License, they do not excuse you from the | ||
| conditions of this License. If you cannot convey a covered work so as to satisfy | ||
| simultaneously your obligations under this License and any other pertinent | ||
| obligations, then as a consequence you may not convey it at all. For example, if you | ||
| agree to terms that obligate you to collect a royalty for further conveying from | ||
| those to whom you convey the Program, the only way you could satisfy both those terms | ||
| and this License would be to refrain entirely from conveying the Program. | ||
|
|
||
| ### 13. Use with the GNU Affero General Public License | ||
|
|
||
| Notwithstanding any other provision of this License, you have permission to link or | ||
| combine any covered work with a work licensed under version 3 of the GNU Affero | ||
| General Public License into a single combined work, and to convey the resulting work. | ||
| The terms of this License will continue to apply to the part which is the covered | ||
| work, but the special requirements of the GNU Affero General Public License, section | ||
| 13, concerning interaction through a network will apply to the combination as such. | ||
|
|
||
| ### 14. Revised Versions of this License | ||
|
|
||
| The Free Software Foundation may publish revised and/or new versions of the GNU | ||
| General Public License from time to time. Such new versions will be similar in spirit | ||
| to the present version, but may differ in detail to address new problems or concerns. | ||
|
|
||
| Each version is given a distinguishing version number. If the Program specifies that | ||
| a certain numbered version of the GNU General Public License “or any later | ||
| version” applies to it, you have the option of following the terms and | ||
| conditions either of that numbered version or of any later version published by the | ||
| Free Software Foundation. If the Program does not specify a version number of the GNU | ||
| General Public License, you may choose any version ever published by the Free | ||
| Software Foundation. | ||
|
|
||
| If the Program specifies that a proxy can decide which future versions of the GNU | ||
| General Public License can be used, that proxy's public statement of acceptance of a | ||
| version permanently authorizes you to choose that version for the Program. | ||
|
|
||
| Later license versions may give you additional or different permissions. However, no | ||
| additional obligations are imposed on any author or copyright holder as a result of | ||
| your choosing to follow a later version. | ||
|
|
||
| ### 15. Disclaimer of Warranty | ||
|
|
||
| THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. | ||
| EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES | ||
| PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER | ||
| EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | ||
| MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE | ||
| QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE | ||
| DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. | ||
|
|
||
| ### 16. Limitation of Liability | ||
|
|
||
| IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY | ||
| COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS | ||
| PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, | ||
| INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE | ||
| PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE | ||
| OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE | ||
| WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE | ||
| POSSIBILITY OF SUCH DAMAGES. | ||
|
|
||
| ### 17. Interpretation of Sections 15 and 16 | ||
|
|
||
| If the disclaimer of warranty and limitation of liability provided above cannot be | ||
| given local legal effect according to their terms, reviewing courts shall apply local | ||
| law that most closely approximates an absolute waiver of all civil liability in | ||
| connection with the Program, unless a warranty or assumption of liability accompanies | ||
| a copy of the Program in return for a fee. | ||
|
|
||
| _END OF TERMS AND CONDITIONS_ | ||
|
|
||
| ## How to Apply These Terms to Your New Programs | ||
|
|
||
| If you develop a new program, and you want it to be of the greatest possible use to | ||
| the public, the best way to achieve this is to make it free software which everyone | ||
| can redistribute and change under these terms. | ||
|
|
||
| To do so, attach the following notices to the program. It is safest to attach them | ||
| to the start of each source file to most effectively state the exclusion of warranty; | ||
| and each file should have at least the “copyright” line and a pointer to | ||
| where the full notice is found. | ||
|
|
||
| <one line to give the program's name and a brief idea of what it does.> | ||
| Copyright (C) <year> <name of author> | ||
|
|
||
| This program is free software: you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License as published by | ||
| the Free Software Foundation, either version 3 of the License, or | ||
| (at your option) any later version. | ||
|
|
||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU General Public License for more details. | ||
|
|
||
| You should have received a copy of the GNU General Public License | ||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| Also add information on how to contact you by electronic and paper mail. | ||
|
|
||
| If the program does terminal interaction, make it output a short notice like this | ||
| when it starts in an interactive mode: | ||
|
|
||
| <program> Copyright (C) <year> <name of author> | ||
| This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. | ||
| This is free software, and you are welcome to redistribute it | ||
| under certain conditions; type 'show c' for details. | ||
|
|
||
| The hypothetical commands `show w` and `show c` should show the appropriate parts of | ||
| the General Public License. Of course, your program's commands might be different; | ||
| for a GUI interface, you would use an “about box”. | ||
|
|
||
| You should also get your employer (if you work as a programmer) or school, if any, to | ||
| sign a “copyright disclaimer” for the program, if necessary. For more | ||
| information on this, and how to apply and follow the GNU GPL, see | ||
| <<http://www.gnu.org/licenses/>>. | ||
|
|
||
| The GNU General Public License does not permit incorporating your program into | ||
| proprietary programs. If your program is a subroutine library, you may consider it | ||
| more useful to permit linking proprietary applications with the library. If this is | ||
| what you want to do, use the GNU Lesser General Public License instead of this | ||
| License. But first, please read | ||
| <<http://www.gnu.org/philosophy/why-not-lgpl.html>>. |
There was a problem hiding this comment.
License file addition appears unrelated to PR objectives.
This PR is focused on implementing Face Search functionality (face names, dates, events, auto-redirect), but includes the addition of a complete GPL v3 license file. While adding proper licensing is good practice, it should be in a separate PR dedicated to project licensing and legal housekeeping rather than mixed with feature development.
Consider moving this to a separate PR to keep changes focused and reviewable.
🧰 Tools
🪛 LanguageTool
[style] ~19-~19: To make your writing flow more naturally, try moving ‘also’ before the verb.
Context: ...ic License for most of our software; it applies also to any other work released this way by ...
(ALSO_PLACEMENT)
[style] ~173-~173: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...by exercising rights under this License with respect to the covered work, and you disclaim any ...
(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)
[style] ~253-~253: Consider using only “public” to avoid wordiness.
Context: ...ce of the work are being offered to the general public at no charge under subsection 6d. A se...
(GENERAL_XX)
[style] ~363-~363: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... the violation by some reasonable means prior to 60 days after the cessation. Moreover,...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~369-~369: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...ight holder, and you cure the violation prior to 30 days after your receipt of the notic...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~379-~379: Consider a more concise word here.
Context: ...are not required to accept this License in order to receive or run a copy of the Program. A...
(IN_ORDER_TO_PREMIUM)
[style] ~380-~380: To make your writing clearer, consider a shorter, more direct phrase.
Context: ...tion of a covered work occurring solely as a consequence of using peer-to-peer transmission to rece...
(AS_A_CONSEQUENCE_OF)
[style] ~420-~420: To make your writing clearer, consider a shorter, more direct phrase.
Context: ...ude claims that would be infringed only as a consequence of further modification of the contributor...
(AS_A_CONSEQUENCE_OF)
[uncategorized] ~460-~460: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...conveying the work, and under which the third party grants, to any of the parties who would...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~465-~465: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...nt, or that patent license was granted, prior to 28 March 2007. Nothing in this License...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~475-~475: ‘So as to’ expresses purpose and is used in formal texts. Consider using “to”.
Context: ...se. If you cannot convey a covered work so as to satisfy simultaneously your obligations...
(SO_AS_TO)
[style] ~583-~583: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “GUI”.
Context: ...am's commands might be different; for a GUI interface, you would use an “about box”. You sho...
(ACRONYM_TAUTOLOGY)
🪛 markdownlint-cli2 (0.18.1)
10-10: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
66-66: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
68-68: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
105-105: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
142-142: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
164-164: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
178-178: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
190-190: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
219-219: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
299-299: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
353-353: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
377-377: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
387-387: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
410-410: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
471-471: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
482-482: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
491-491: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
513-513: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
523-523: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
534-534: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
542-542: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
544-544: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
🤖 Prompt for AI Agents
In `@LICENSE.md` around lines 1 - 595, The PR mixes an unrelated LICENSE.md
addition with the Face Search feature (face names, dates, events,
auto-redirect); remove LICENSE.md from this branch and put it into a dedicated
licensing PR: revert or remove the LICENSE.md file from the current commit (or
create a new commit that deletes LICENSE.md), push the branch update, then
create a new branch/PR that adds LICENSE.md (with an explanatory commit message)
so the Face Search changes remain focused and reviewable.
| # ---- Set up the sync-microservice using Python 3.12 ---- | ||
| Write-Host "Setting up sync-microservice..." -ForegroundColor Yellow | ||
| try { | ||
| Set-Location .\sync-microservice\ | ||
|
|
||
| # Create virtual environment | ||
| python -m venv .sync-env | ||
|
|
||
| # Activate virtual environment and install dependencies | ||
| .\.sync-env\Scripts\Activate.ps1 | ||
| python -m pip install --upgrade pip | ||
| python -m pip install -r requirements.txt | ||
| deactivate | ||
|
|
||
| Set-Location .. | ||
|
|
||
| Write-Host "Sync-microservice setup completed successfully." -ForegroundColor Green | ||
| } catch { | ||
| Write-Host "Error setting up sync-microservice: $_" -ForegroundColor Red | ||
| Set-Location $PSScriptRoot # Return to original directory | ||
| } |
There was a problem hiding this comment.
Fail fast when sync-microservice setup fails.
If setup errors out, the script still proceeds to the final “Windows setup complete!” message, which can mask a failed sync-microservice install. Consider exiting non‑zero after logging the error.
🔧 Proposed fix
} catch {
Write-Host "Error setting up sync-microservice: $_" -ForegroundColor Red
Set-Location $PSScriptRoot # Return to original directory
+ exit 1
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # ---- Set up the sync-microservice using Python 3.12 ---- | |
| Write-Host "Setting up sync-microservice..." -ForegroundColor Yellow | |
| try { | |
| Set-Location .\sync-microservice\ | |
| # Create virtual environment | |
| python -m venv .sync-env | |
| # Activate virtual environment and install dependencies | |
| .\.sync-env\Scripts\Activate.ps1 | |
| python -m pip install --upgrade pip | |
| python -m pip install -r requirements.txt | |
| deactivate | |
| Set-Location .. | |
| Write-Host "Sync-microservice setup completed successfully." -ForegroundColor Green | |
| } catch { | |
| Write-Host "Error setting up sync-microservice: $_" -ForegroundColor Red | |
| Set-Location $PSScriptRoot # Return to original directory | |
| } | |
| # ---- Set up the sync-microservice using Python 3.12 ---- | |
| Write-Host "Setting up sync-microservice..." -ForegroundColor Yellow | |
| try { | |
| Set-Location .\sync-microservice\ | |
| # Create virtual environment | |
| python -m venv .sync-env | |
| # Activate virtual environment and install dependencies | |
| .\.sync-env\Scripts\Activate.ps1 | |
| python -m pip install --upgrade pip | |
| python -m pip install -r requirements.txt | |
| deactivate | |
| Set-Location .. | |
| Write-Host "Sync-microservice setup completed successfully." -ForegroundColor Green | |
| } catch { | |
| Write-Host "Error setting up sync-microservice: $_" -ForegroundColor Red | |
| Set-Location $PSScriptRoot # Return to original directory | |
| exit 1 | |
| } |
🤖 Prompt for AI Agents
In `@scripts/setup.ps1` around lines 153 - 173, The catch block currently logs the
error but allows the script to continue; update the catch so that after
Write-Host and restoring the working directory with Set-Location $PSScriptRoot
it terminates the script with a non‑zero exit (e.g., call exit 1 or throw) to
fail fast; adjust the catch surrounding the try/catch block that contains the
virtualenv creation/activation and use the existing symbols (try, catch,
Write-Host, Set-Location $PSScriptRoot) and add an exit 1 (or throw) to stop
further execution when the sync-microservice setup fails.
| # ---- Set up the sync-microservice ---- | ||
| echo -e "${YELLOW}Setting up sync-microservice...${NC}" | ||
| cd sync-microservice | ||
| python -m venv .sync-env | ||
| source .sync-env/bin/activate | ||
| pip install --upgrade pip | ||
| pip install -r requirements.txt | ||
| deactivate | ||
| cd .. |
There was a problem hiding this comment.
Guard cd sync-microservice to avoid running in the wrong directory.
If the directory is missing, the script continues and installs dependencies from the wrong location. ShellCheck SC2164 flags this.
🔧 Proposed fix
-cd sync-microservice
+cd sync-microservice || { echo -e "${RED}sync-microservice directory not found${NC}"; exit 1; }📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # ---- Set up the sync-microservice ---- | |
| echo -e "${YELLOW}Setting up sync-microservice...${NC}" | |
| cd sync-microservice | |
| python -m venv .sync-env | |
| source .sync-env/bin/activate | |
| pip install --upgrade pip | |
| pip install -r requirements.txt | |
| deactivate | |
| cd .. | |
| # ---- Set up the sync-microservice ---- | |
| echo -e "${YELLOW}Setting up sync-microservice...${NC}" | |
| cd sync-microservice || { echo -e "${RED}sync-microservice directory not found${NC}"; exit 1; } | |
| python -m venv .sync-env | |
| source .sync-env/bin/activate | |
| pip install --upgrade pip | |
| pip install -r requirements.txt | |
| deactivate | |
| cd .. |
🧰 Tools
🪛 Shellcheck (0.11.0)
[warning] 104-104: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
(SC2164)
🤖 Prompt for AI Agents
In `@scripts/setup.sh` around lines 102 - 110, Guard the cd sync-microservice step
by first checking that the directory exists (test -d "sync-microservice") and if
not, log an error and exit; then perform cd, create the virtualenv .sync-env,
activate it, install pip and requirements, deactivate and cd .. only when the
directory change succeeded. Update the block around the cd sync-microservice,
.sync-env creation and deactivate to fail fast if the directory is missing or cd
fails, so the pip install -r requirements.txt does not run in the wrong
location.
2 participants
This PR primarily fixes #555 by implementing Face Search functionality using face names, dates, and events.
What this PR does:
User Impact:
Preview available here
https://github.com/user-attachments/assets/72ef7dfc-45b8-4974-a2d3-a9990965825d
Summary by CodeRabbit
New Features
Bug Fixes
Chores
✏️ Tip: You can customize this high-level summary in your review settings.