mirror of
https://github.com/brunopostle/ifcurl.git
synced 2026-07-12 10:18:14 +00:00
viewer.html: copy URL, create issue, element properties, load progress
- Add ⎘ button to copy the current ifc:// URL to clipboard - Add Issue button to open a pre-filled new issue on the git host - Add click-to-identify via OBC.Highlighter: clicking an element shows its IFC type, name, and GlobalId in a panel with a copy button - Replace arrayBuffer() with ReadableStream loop showing fetch progress as percentage (when Content-Length known) or MB transferred - README: document viewer features, collaboration workflow, and that private Forgejo repos work via same-origin session cookie - CLAUDE.md: document that [attr=val] bracket selector syntax is invalid; correct form is comma-separated (IfcWall, Name="...") and bare GlobalId Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
a1fc88e59d
commit
63c0cc7ada
4 changed files with 206 additions and 8 deletions
|
|
@ -1,13 +1,13 @@
|
|||
{"id":"ifcurl-p60","title":"Viewer: no element click-to-identify — can't get GlobalId or properties","description":"There is no way to click on a mesh in the viewer and see which IFC element it represents. Reviewers can see geometry but cannot reference specific elements — they can't discover a GlobalId to put in a selector URL, can't see the element name/type/Psets, and can't say 'this specific wall' in a BCF or Forgejo comment. This breaks the collaboration workflow at its foundation: every useful feedback comment needs to identify specific elements. Need: click or hover on a surface to highlight it and show a properties panel (name, type, GlobalId, key Psets). The GlobalId should be copyable into the selector field or URL. The ThatOpen components library provides the tools for this (OBC.IfcRelationsIndexer, element property queries).","status":"open","priority":1,"issue_type":"feature","owner":"bruno@postle.net","created_at":"2026-04-24T11:02:33Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:02:33Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-p60","title":"Viewer: no element click-to-identify — can't get GlobalId or properties","description":"There is no way to click on a mesh in the viewer and see which IFC element it represents. Reviewers can see geometry but cannot reference specific elements — they can't discover a GlobalId to put in a selector URL, can't see the element name/type/Psets, and can't say 'this specific wall' in a BCF or Forgejo comment. This breaks the collaboration workflow at its foundation: every useful feedback comment needs to identify specific elements. Need: click or hover on a surface to highlight it and show a properties panel (name, type, GlobalId, key Psets). The GlobalId should be copyable into the selector field or URL. The ThatOpen components library provides the tools for this (OBC.IfcRelationsIndexer, element property queries).","status":"closed","priority":1,"issue_type":"feature","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T11:02:33Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:47:23Z","started_at":"2026-04-24T11:14:57Z","closed_at":"2026-04-24T11:47:23Z","close_reason":"Closed","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-4l7","title":"viewer.html: scale= URLs don't load in orthographic mode","description":"applyCameraParam() reads the camera= and fov= parameters from the URL and applies them, but never reads scale= or switches the camera to orthographic (parallel) projection. URLs like ?camera=...\u0026scale=50 will load in perspective mode instead of orthographic. The OBC OrthoPerspectiveCamera can switch modes, but the code path to set parallel projection and apply the scale value is missing from applyCameraParam.","status":"closed","priority":1,"issue_type":"bug","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T09:04:51Z","created_by":"Bruno Postle","updated_at":"2026-04-24T10:56:29Z","started_at":"2026-04-24T10:50:19Z","closed_at":"2026-04-24T10:56:29Z","close_reason":"Closed","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-362","title":"Add missing server-config files: gitconfig-ifcmerge and gitattributes","description":"forgejo/README.md documents deploying two files that don't exist in the repo: forgejo/server-config/gitconfig-ifcmerge and forgejo/server-config/gitattributes. Both are required for the ifcmerge git merge driver to work in bare Forgejo repos. The README even includes 'sudo cp forgejo/server-config/gitattributes /etc/gitattributes' and 'sudo git config --system include.path .../gitconfig-ifcmerge', but the files themselves are absent. Anyone following the deployment instructions will hit a 'file not found' error. Need to create both files with the content described in the README.","status":"closed","priority":1,"issue_type":"bug","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T09:04:31Z","created_by":"Bruno Postle","updated_at":"2026-04-24T10:51:47Z","started_at":"2026-04-24T10:50:15Z","closed_at":"2026-04-24T10:51:47Z","close_reason":"Files already exist: forgejo/server-config/gitconfig-ifcmerge and gitattributes are both present and correct. Missed in initial review.","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-9cr","title":"ifc:// URLs in Forgejo issues and PR comments not documented as a collaboration tool","description":"Forgejo's markdown extension renders ifc:// URLs as clickable 3D preview images in file README views, but it works equally in issue bodies, PR descriptions, and comment threads — which is where the actual collaboration happens. This is potentially the most useful feature: a reviewer can paste an ifc:// URL in a PR comment and everyone in the thread sees the 3D view inline. This is not mentioned anywhere in README.md, forgejo/README.md, or SPECIFICATION.md. Add a 'Collaboration workflow' section to the README showing: (1) navigate to view in viewer, (2) copy URL from address bar, (3) paste as [label](ifc://...) in a Forgejo comment/issue, (4) collaborators click the preview image to open the view.","status":"open","priority":2,"issue_type":"task","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:44Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:03:44Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-9cr","title":"ifc:// URLs in Forgejo issues and PR comments not documented as a collaboration tool","description":"Forgejo's markdown extension renders ifc:// URLs as clickable 3D preview images in file README views, but it works equally in issue bodies, PR descriptions, and comment threads — which is where the actual collaboration happens. This is potentially the most useful feature: a reviewer can paste an ifc:// URL in a PR comment and everyone in the thread sees the 3D view inline. This is not mentioned anywhere in README.md, forgejo/README.md, or SPECIFICATION.md. Add a 'Collaboration workflow' section to the README showing: (1) navigate to view in viewer, (2) copy URL from address bar, (3) paste as [label](ifc://...) in a Forgejo comment/issue, (4) collaborators click the preview image to open the view.","status":"closed","priority":2,"issue_type":"task","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:44Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:47:24Z","started_at":"2026-04-24T11:14:59Z","closed_at":"2026-04-24T11:47:24Z","close_reason":"Closed","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-n00","title":"Forgejo markdown previews fail silently for private repos — no auth path from preview service","description":"The Forgejo markdown extension generates \u003cimg src='http://localhost:8000/preview?url=ifc://...'\u003e tags. The preview service fetches the IFC file server-side using GET /preview with no authentication. For private repos, this returns HTTP 404 or 403 and the preview image shows as broken. There is no mechanism for the Forgejo markdown renderer to pass the user's session token to the preview service. Options to investigate: (1) the Forgejo integration could pass a signed request token; (2) the preview service could run as the Forgejo git user (which has read access to all repos); (3) SSH-based fetch from the service using the Forgejo server's own key. The current state is a silent failure that will confuse users.","status":"open","priority":2,"issue_type":"bug","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:39Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:03:39Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-2y6","title":"Private Forgejo repos work in viewer via session cookie (same-origin) but this is undocumented and untested","description":"When the viewer is served at https://forgejo.example.com/assets/viewer.html, toRawUrl() constructs a same-origin URL like https://forgejo.example.com/org/repo/raw/branch/main/model.ifc. The browser automatically attaches the Forgejo session cookie to this fetch, so private repos on the same Forgejo instance should be accessible to logged-in users without any extra configuration. This is a significant capability that is not documented or tested. Needs: (1) a test or note confirming this works, (2) documentation in forgejo/README.md explaining that private repos work automatically for logged-in users when the viewer is served from the same Forgejo instance, (3) clear note that external repos (other Forgejo, GitHub, GitLab) have no auth path from the browser viewer.","status":"open","priority":2,"issue_type":"task","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:26Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:03:26Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-2y6","title":"Private Forgejo repos work in viewer via session cookie (same-origin) but this is undocumented and untested","description":"When the viewer is served at https://forgejo.example.com/assets/viewer.html, toRawUrl() constructs a same-origin URL like https://forgejo.example.com/org/repo/raw/branch/main/model.ifc. The browser automatically attaches the Forgejo session cookie to this fetch, so private repos on the same Forgejo instance should be accessible to logged-in users without any extra configuration. This is a significant capability that is not documented or tested. Needs: (1) a test or note confirming this works, (2) documentation in forgejo/README.md explaining that private repos work automatically for logged-in users when the viewer is served from the same Forgejo instance, (3) clear note that external repos (other Forgejo, GitHub, GitLab) have no auth path from the browser viewer.","status":"closed","priority":2,"issue_type":"task","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:26Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:47:25Z","started_at":"2026-04-24T11:15:00Z","closed_at":"2026-04-24T11:47:25Z","close_reason":"Closed","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-u8a","title":"PR review: no before/after 3D render when an IFC file is modified","description":"When a Forgejo PR modifies a .ifc file, the Files Changed tab shows raw STEP text diff — completely unreadable. Reviewers cannot see what geometry changed. The system should automatically add before/after rendered PNG images to the PR description or as a PR check comment when an .ifc file is modified. The service can render both the base-branch version and the PR-branch version using the commit hexshas already available in the PR context. This is the single most important workflow gap for IFC code review — currently 100% of the visual review burden falls on the reviewer manually opening the viewer and navigating. This supersedes and expands the existing ifcurl-prc issue.","status":"open","priority":2,"issue_type":"feature","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:21Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:03:21Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-sgv","title":"BCF import in viewer: reconstruct ifc:// URL from a BCF viewpoint file","description":"BCF is a standard exchange format for BIM issue tracking. Reviewers using other tools (Solibri, Navisworks, BIMcollab) will generate BCF files. There is currently no way to open a BCF file in the viewer to see the referenced view. Implement BCF import: accept a .bcf zip via drag-and-drop or a file picker, parse the first viewpoint's camera/clips, construct an ifc:// URL from the Components/Selection GUIDs (as a GUID-based selector), and load the view. This also completes SPECIFICATION.md §6 direction 2. The ifc:// URL base (repo, ref, path) cannot be recovered from BCF alone — the viewer should keep the current model context and only apply the viewpoint.","status":"open","priority":2,"issue_type":"feature","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:07Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:03:07Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-qcw","title":"Viewer: no 'Create Forgejo issue' button — BCF export and Forgejo issues are disconnected","description":"The BCF export downloads a file that the reviewer must then manually attach to a Forgejo issue. There is no direct path from 'I found a problem in the viewer' to 'this is now a Forgejo issue'. The feedback loop — reviewer flags, designer fixes, reviewer verifies — requires the issue to live in Forgejo where the code/model review happens. A 'Report issue' button in the viewer should call the Forgejo API (POST /api/v1/repos/{owner}/{repo}/issues) with the current ifc:// URL pre-filled in the issue description, so the issue body automatically renders a clickable 3D preview. The viewer already knows the repo path (from the URL) and when served by Forgejo the user is already authenticated.","status":"open","priority":2,"issue_type":"feature","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:03Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:03:03Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-unu","title":"Viewer: no 'Copy URL' / share button — relies on users knowing to use the address bar","description":"The viewer continuously updates the browser address bar via history.replaceState so the current view is always shareable. But there is no visible 'Copy link to this view' button. Non-technical users (clients, project managers) will not know to copy from the address bar, especially when the URL is long and truncated. A clipboard button alongside the BCF button — or a dedicated Share toolbar item — would make the core sharing workflow discoverable. Should copy the ifc:// URL (from urlInput, which reflects current camera state) to the clipboard and briefly confirm with a visual indicator.","status":"open","priority":2,"issue_type":"feature","owner":"bruno@postle.net","created_at":"2026-04-24T11:02:49Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:02:49Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-qcw","title":"Viewer: no 'Create Forgejo issue' button — BCF export and Forgejo issues are disconnected","description":"The BCF export downloads a file that the reviewer must then manually attach to a Forgejo issue. There is no direct path from 'I found a problem in the viewer' to 'this is now a Forgejo issue'. The feedback loop — reviewer flags, designer fixes, reviewer verifies — requires the issue to live in Forgejo where the code/model review happens. A 'Report issue' button in the viewer should call the Forgejo API (POST /api/v1/repos/{owner}/{repo}/issues) with the current ifc:// URL pre-filled in the issue description, so the issue body automatically renders a clickable 3D preview. The viewer already knows the repo path (from the URL) and when served by Forgejo the user is already authenticated.","status":"closed","priority":2,"issue_type":"feature","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:03Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:47:24Z","started_at":"2026-04-24T11:14:58Z","closed_at":"2026-04-24T11:47:24Z","close_reason":"Closed","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-unu","title":"Viewer: no 'Copy URL' / share button — relies on users knowing to use the address bar","description":"The viewer continuously updates the browser address bar via history.replaceState so the current view is always shareable. But there is no visible 'Copy link to this view' button. Non-technical users (clients, project managers) will not know to copy from the address bar, especially when the URL is long and truncated. A clipboard button alongside the BCF button — or a dedicated Share toolbar item — would make the core sharing workflow discoverable. Should copy the ifc:// URL (from urlInput, which reflects current camera state) to the clipboard and briefly confirm with a visual indicator.","status":"closed","priority":2,"issue_type":"feature","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T11:02:49Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:47:23Z","started_at":"2026-04-24T11:14:38Z","closed_at":"2026-04-24T11:47:23Z","close_reason":"Closed","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-9rk","title":"pyproject.toml: bcf package not listed as optional service dependency","description":"service.py and bcf.py work correctly because the 'bcf' Python library is installed, but it is not listed in pyproject.toml's [service] or [render] optional dependencies. A fresh install with 'pip install ifcurl[service]' may not install it. Add bcf to the [service] extras to make the dependency explicit.","status":"closed","priority":2,"issue_type":"bug","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T10:41:19Z","created_by":"Bruno Postle","updated_at":"2026-04-24T10:56:27Z","started_at":"2026-04-24T10:50:11Z","closed_at":"2026-04-24T10:56:27Z","close_reason":"Closed","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-czd","title":"GET /preview has no token parameter — private repos inaccessible","description":"POST /preview accepts a token field in the JSON body for private repository authentication. GET /preview (used by Forgejo \u003cimg src=\u003e tags) only takes a url query parameter with no way to pass a token. The Go markdown extension generates img tags using the GET form. This means inline previews in Forgejo markdown can never authenticate to private repos — they will silently fail or return 404. Either the Go extension should use POST, or a separate signed/session-scoped token mechanism is needed for the GET path.","status":"open","priority":2,"issue_type":"bug","owner":"bruno@postle.net","created_at":"2026-04-24T10:40:17Z","created_by":"Bruno Postle","updated_at":"2026-04-24T10:40:17Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-3n4","title":"viewer-url.js: toRawUrl GitLab host detection too broad","description":"toRawUrl() uses host.includes('gitlab') to detect GitLab instances, which matches any hostname containing the string 'gitlab' — e.g. 'not-actually-gitlab.example.com' would be routed to the GitLab raw URL pattern. Should use a more specific check: host === 'gitlab.com' or host.startsWith('gitlab.') to avoid false positives on unrelated hostnames.","status":"closed","priority":2,"issue_type":"bug","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T10:40:01Z","created_by":"Bruno Postle","updated_at":"2026-04-24T10:56:28Z","started_at":"2026-04-24T10:50:14Z","closed_at":"2026-04-24T10:56:28Z","close_reason":"Closed","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
|
|
@ -43,7 +43,7 @@
|
|||
{"id":"ifcurl-f3p","title":"footer.tmpl: 'View in 3D' button absent from file history (git log) page","description":"The 'View in 3D' button is injected on the file view page (showing one commit of a file). It is not shown on the file history page (the list of commits that touched a file), which is where users naturally go to see how a model evolved over time. Each entry in the history list already has a commit hash in its href. Injecting a 'View in 3D' link or button alongside each history entry would let reviewers quickly compare model states across commits — which is a primary collaboration use case.","status":"open","priority":3,"issue_type":"feature","owner":"bruno@postle.net","created_at":"2026-04-24T11:04:23Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:04:23Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-4rj","title":"Viewer: no branch/ref switcher — can't navigate model history or compare versions","description":"The viewer loads a single ifc:// URL and has no UI to switch to a different ref. A reviewer wanting to see 'what did this look like on main before the PR' or 'show me the v1.2 tag' must manually edit the URL. For a collaboration tool, being able to flip between 'current PR branch' and 'base branch' at the same camera view is essential for review. Consider a ref dropdown or input in the toolbar that reconstructs the URL with a different @ref, preserving camera/clip/selector state. The structured fields already expose repo/ref/path — the ref field is editable but not prominently labelled as a version picker.","status":"open","priority":3,"issue_type":"feature","owner":"bruno@postle.net","created_at":"2026-04-24T11:04:20Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:04:20Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-np8","title":"Viewer depends on CDN (unpkg, esm.sh) — broken in air-gapped or restricted networks","description":"viewer.html loads all JavaScript from public CDNs: three.js from esm.sh, @thatopen/components and fragments from esm.sh/unpkg, web-ifc WASM from unpkg, the fragment worker from unpkg, JSZip from esm.sh. In corporate BIM environments with restricted internet (common in construction/engineering), the viewer will fail to load entirely. There is no documented self-hosted path. Consider: document how to serve the dependencies from the Forgejo instance's own /assets/ directory, or provide a bundled viewer.html as a build artifact. The viewer worker fetch ('https://unpkg.com/@thatopen/fragments@3.3.1/dist/Worker/worker.mjs') is already fetched at runtime with a special workaround for Firefox — this is the most fragile CDN dependency.","status":"open","priority":3,"issue_type":"task","owner":"bruno@postle.net","created_at":"2026-04-24T11:04:04Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:04:04Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-sa0","title":"Viewer: no load progress — large IFC files appear to hang","description":"The viewer status shows 'Fetching IFC file…' and 'Parsing IFC…' as plain text but gives no indication of how far along the download or parse is. IFC files in real projects are often 20–200MB. The fetch() call and the web-ifc WASM parser both block for seconds with no visual feedback. A progress bar or percentage indicator during fetch (using response.body ReadableStream + Content-Length header) and a spinner during parse would prevent users abandoning the page thinking it crashed. The status element exists and is already used — it just needs richer updates.","status":"open","priority":3,"issue_type":"task","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:58Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:03:58Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-sa0","title":"Viewer: no load progress — large IFC files appear to hang","description":"The viewer status shows 'Fetching IFC file…' and 'Parsing IFC…' as plain text but gives no indication of how far along the download or parse is. IFC files in real projects are often 20–200MB. The fetch() call and the web-ifc WASM parser both block for seconds with no visual feedback. A progress bar or percentage indicator during fetch (using response.body ReadableStream + Content-Length header) and a spinner during parse would prevent users abandoning the page thinking it crashed. The status element exists and is already used — it just needs richer updates.","status":"closed","priority":3,"issue_type":"task","assignee":"Bruno Postle","owner":"bruno@postle.net","created_at":"2026-04-24T11:03:58Z","created_by":"Bruno Postle","updated_at":"2026-04-24T11:47:23Z","started_at":"2026-04-24T11:14:56Z","closed_at":"2026-04-24T11:47:23Z","close_reason":"Closed","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-4xl","title":"viewer.html: selector support is a subset of IfcOpenShell syntax — not documented","description":"applySelector() in the viewer only handles type-name union syntax ('IfcWall+IfcSlab'). The comment says 'Attribute/property filters not yet supported', but this limitation is not visible to users and not documented in README.md or SPECIFICATION.md. A user pasting a URL with 'selector=IfcWall,+Pset_WallCommon.FireRating=2HR' will see all elements rather than the filtered set, with no error. Should add a user-visible note or at minimum document the viewer's selector limitations.","status":"open","priority":3,"issue_type":"task","owner":"bruno@postle.net","created_at":"2026-04-24T10:41:49Z","created_by":"Bruno Postle","updated_at":"2026-04-24T10:41:49Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-fu5","title":"service.py: no rate limiting or request size cap on /preview and /bcf","description":"The preview and BCF endpoints have no rate limiting, no cap on IFC file size fetched, and no timeout on the render operation. A single large IFC file or a flood of requests can saturate memory and CPU. Consider: max IFC blob size (reject fetch if commit object too large), render timeout via threading.Timer, and a simple in-process rate limiter or documentation that a reverse proxy (nginx) should front the service with rate limits.","status":"open","priority":3,"issue_type":"task","owner":"bruno@postle.net","created_at":"2026-04-24T10:41:45Z","created_by":"Bruno Postle","updated_at":"2026-04-24T10:41:45Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
{"id":"ifcurl-d58","title":"ifc_url_test.go: no test for bare URL with path containing @ character","description":"The Go transformer reassembles multi-sibling text nodes for bare ifc:// URLs. There is a test for underscores in the path (which goldmark splits on), but no test for paths or query values containing '@', which is a valid character in query strings and could appear in selector expressions. Also missing: test for a bare URL followed immediately by punctuation like a period or closing parenthesis to verify the terminator logic.","status":"open","priority":3,"issue_type":"task","owner":"bruno@postle.net","created_at":"2026-04-24T10:41:32Z","created_by":"Bruno Postle","updated_at":"2026-04-24T10:41:32Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ Tier 4: full URL hash → rendered PNG (**never** applied to mutable refs like `
|
|||
## Key domain facts
|
||||
|
||||
- All spatial values (`camera`, `clip`) are in IFC world coordinates, matching BCF viewpoint conventions — not georeferenced survey coordinates.
|
||||
- The `selector` parameter uses IfcOpenShell selector syntax. `+` joins selector groups (union); `,` separates filters within a group.
|
||||
- The `selector` parameter uses IfcOpenShell selector syntax. `+` joins selector groups (union); `,` separates filters within a group. **`[attr=val]` bracket notation is NOT valid** — the correct form is `IfcWall, Name="Core Wall"`. A bare 22-char GlobalId selects a single element: `selector=325Q7Fhnf67OZC$$r43uzK`.
|
||||
- `IFCDOCUMENTREFERENCE` location fields may be relative paths (resolved within the same repo/ref), absolute local paths (desktop only), or `ifc://` URLs (cross-repo federation).
|
||||
- BCF ↔ IFC URL conversion is defined in `SPECIFICATION.md` §6.
|
||||
|
||||
|
|
|
|||
49
README.md
49
README.md
|
|
@ -214,6 +214,55 @@ No build step — loads dependencies from CDN.
|
|||
- FOV control, camera sync — the URL in the browser bar always reflects the
|
||||
current view and is shareable
|
||||
- Drag-and-drop ifc:// URLs onto the page
|
||||
- **Click to identify** — click any element to see its IFC type, name, and
|
||||
GlobalId in a side panel; copy GlobalId to clipboard for use in selectors
|
||||
- **⎘ copy** button — copies the current ifc:// URL to clipboard
|
||||
- **Issue** button — opens a new issue on the git host with the ifc:// URL
|
||||
pre-filled in the body (works for Forgejo, GitHub, GitLab)
|
||||
- **BCF export** — exports the current view (camera, clipping planes, selected
|
||||
elements) as a BCF 2.1 file for import into Revit, Navisworks, etc.
|
||||
- Download progress — shows percentage or MB while fetching large IFC files
|
||||
|
||||
### Collaboration workflow
|
||||
|
||||
`ifc://` URLs function as view permalinks that can be embedded anywhere:
|
||||
Forgejo issues and comments, pull request discussions, markdown documentation,
|
||||
Slack, or email.
|
||||
|
||||
**Basic flow:**
|
||||
|
||||
1. Open the viewer and navigate to the view you want to share
|
||||
2. Add clipping planes or a selector to isolate the relevant geometry
|
||||
3. Click **⎘** to copy the ifc:// URL, or **Issue** to open a pre-filled issue
|
||||
4. Paste the URL into a Forgejo issue, PR comment, or any markdown file —
|
||||
Forgejo will render it inline as a linked preview image
|
||||
|
||||
**Referencing specific elements:**
|
||||
|
||||
Click any element to see its GlobalId. Copy the GlobalId and paste it directly
|
||||
as the `selector=` value — a bare 22-character GlobalId selects that one element
|
||||
(e.g., `selector=325Q7Fhnf67OZC$$r43uzK`). Use `visibility=highlight`, `ghost`,
|
||||
or `isolate` to control how the selection is displayed.
|
||||
|
||||
**BCF export for external tools:**
|
||||
|
||||
Use the **BCF** button to export a BCF 2.1 file. The resulting `.bcf` can be
|
||||
attached to a Forgejo issue as a file, or imported into Revit, Navisworks,
|
||||
Solibri, or any BCF-compatible tool to communicate the exact viewpoint and
|
||||
element selection to contractors or consultants using proprietary software.
|
||||
|
||||
### Authentication
|
||||
|
||||
When the viewer is served from the same Forgejo instance
|
||||
(`https://git.example.com/assets/viewer.html`), it shares the browser session
|
||||
cookie. Any IFC file that the logged-in user can access on that Forgejo instance
|
||||
loads without extra configuration — private repositories work automatically for
|
||||
authenticated users.
|
||||
|
||||
IFC files hosted on other platforms (GitHub, GitLab, a different Forgejo
|
||||
instance) are fetched directly from the browser. Only public repositories work
|
||||
for external hosts; there is currently no authentication path for external
|
||||
private repositories in the browser viewer.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -71,6 +71,31 @@
|
|||
background: rgba(28,28,30,0.7);
|
||||
pointer-events: none;
|
||||
}
|
||||
/* Element properties panel */
|
||||
#props-panel {
|
||||
position: fixed; bottom: 44px; right: 12px; z-index: 10;
|
||||
background: rgba(28,28,30,0.92); backdrop-filter: blur(8px);
|
||||
border: 1px solid rgba(255,255,255,0.12); border-radius: 6px;
|
||||
padding: 8px 10px; min-width: 200px; max-width: 320px;
|
||||
}
|
||||
#props-panel-header {
|
||||
display: flex; align-items: center; justify-content: space-between;
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
#props-panel-header span {
|
||||
font-size: 10px; color: #606068;
|
||||
text-transform: uppercase; letter-spacing: 0.06em;
|
||||
}
|
||||
#props-panel .prop-row {
|
||||
display: flex; align-items: baseline; gap: 6px; margin-top: 3px;
|
||||
}
|
||||
#props-panel .prop-label {
|
||||
font-size: 10px; color: #808088; flex-shrink: 0; width: 46px;
|
||||
}
|
||||
#props-panel .prop-value {
|
||||
font-size: 12px; color: #f0f0f0; font-family: monospace;
|
||||
flex: 1; word-break: break-all;
|
||||
}
|
||||
</style>
|
||||
<script type="importmap">
|
||||
{
|
||||
|
|
@ -95,6 +120,8 @@
|
|||
<button id="clip-btn" class="tb-btn" title="Double-click model surface to add clipping plane">✂ clip</button>
|
||||
<button id="clip-clear-btn" class="tb-btn" title="Remove all clipping planes" style="display:none">⊗ clips</button>
|
||||
<button id="bcf-btn" class="tb-btn" title="Export current view as a BCF issue">BCF</button>
|
||||
<button id="copy-url-btn" class="tb-btn" title="Copy ifc:// URL to clipboard">⎘</button>
|
||||
<button id="new-issue-btn" class="tb-btn" title="Open new issue with this view URL">Issue</button>
|
||||
<div id="fov-wrap">
|
||||
FOV <input id="fov-input" class="ti" type="number" min="10" max="120" step="1"
|
||||
title="Field of view (degrees)">°
|
||||
|
|
@ -139,6 +166,25 @@
|
|||
</div>
|
||||
<div id="viewer"></div>
|
||||
<div id="status"></div>
|
||||
<div id="props-panel" style="display:none">
|
||||
<div id="props-panel-header">
|
||||
<span>Element</span>
|
||||
<button id="props-close-btn" class="tb-btn">✕</button>
|
||||
</div>
|
||||
<div class="prop-row">
|
||||
<span class="prop-label">type</span>
|
||||
<span id="props-type" class="prop-value"></span>
|
||||
</div>
|
||||
<div class="prop-row">
|
||||
<span class="prop-label">name</span>
|
||||
<span id="props-name" class="prop-value"></span>
|
||||
</div>
|
||||
<div class="prop-row">
|
||||
<span class="prop-label">GlobalId</span>
|
||||
<span id="props-guid" class="prop-value"></span>
|
||||
<button id="props-copy-btn" class="tb-btn" title="Copy GlobalId to clipboard">⎘</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script type="module">
|
||||
import * as THREE from "three";
|
||||
|
|
@ -156,6 +202,14 @@
|
|||
const refInput = document.getElementById("ref-input");
|
||||
const pathInput = document.getElementById("path-input");
|
||||
const selectorInput = document.getElementById("selector-input");
|
||||
const copyUrlBtn = document.getElementById("copy-url-btn");
|
||||
const newIssueBtn = document.getElementById("new-issue-btn");
|
||||
const propsPanel = document.getElementById("props-panel");
|
||||
const propsType = document.getElementById("props-type");
|
||||
const propsName = document.getElementById("props-name");
|
||||
const propsGuid = document.getElementById("props-guid");
|
||||
const propsCopyBtn = document.getElementById("props-copy-btn");
|
||||
const propsCloseBtn = document.getElementById("props-close-btn");
|
||||
|
||||
// Keep viewer below the full toolbar height.
|
||||
const resizeObs = new ResizeObserver(() => {
|
||||
|
|
@ -227,6 +281,44 @@
|
|||
bcfPanelOpen(false);
|
||||
});
|
||||
|
||||
copyUrlBtn.addEventListener("click", async () => {
|
||||
if (threeCamera) syncCameraUrl(threeCamera);
|
||||
const url = urlInput.value.trim();
|
||||
if (!url) return;
|
||||
try {
|
||||
await navigator.clipboard.writeText(url);
|
||||
const saved = copyUrlBtn.textContent;
|
||||
copyUrlBtn.textContent = "✓";
|
||||
setTimeout(() => { copyUrlBtn.textContent = saved; }, 1500);
|
||||
} catch {
|
||||
urlInput.select();
|
||||
}
|
||||
});
|
||||
|
||||
newIssueBtn.addEventListener("click", () => {
|
||||
if (threeCamera) syncCameraUrl(threeCamera);
|
||||
const src = urlInput.value.trim();
|
||||
if (!src) return;
|
||||
const p = parseIfcUrl(src);
|
||||
if (!p || !p.host || !p.repoSuffix) return;
|
||||
const title = p.path ? `IFC view: ${p.path}` : "IFC view";
|
||||
const issueUrl = `https://${p.host}/${p.repoSuffix}/issues/new` +
|
||||
`?title=${encodeURIComponent(title)}&body=${encodeURIComponent(src)}`;
|
||||
window.open(issueUrl, "_blank", "noopener");
|
||||
});
|
||||
|
||||
propsCloseBtn.addEventListener("click", () => { propsPanel.style.display = "none"; });
|
||||
propsCopyBtn.addEventListener("click", async () => {
|
||||
const guid = propsGuid.textContent;
|
||||
if (!guid) return;
|
||||
try {
|
||||
await navigator.clipboard.writeText(guid);
|
||||
const saved = propsCopyBtn.textContent;
|
||||
propsCopyBtn.textContent = "✓";
|
||||
setTimeout(() => { propsCopyBtn.textContent = saved; }, 1500);
|
||||
} catch { /* ignore */ }
|
||||
});
|
||||
|
||||
const allInputs = [urlInput, fovInput, repoInput, refInput, pathInput, selectorInput,
|
||||
bcfTitleIn, bcfCommentIn];
|
||||
for (const el of allInputs) {
|
||||
|
|
@ -565,6 +657,21 @@
|
|||
URL.revokeObjectURL(a.href);
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Element properties panel
|
||||
// -----------------------------------------------------------------------
|
||||
function showPropsPanel(props, webIfc) {
|
||||
let typeName = String(props.type ?? "");
|
||||
try {
|
||||
const name = webIfc?.GetNameFromTypeCode(props.type);
|
||||
if (name) typeName = name;
|
||||
} catch { /* not available in this version */ }
|
||||
propsType.textContent = typeName;
|
||||
propsName.textContent = props.Name?.value ?? props.LongName?.value ?? "";
|
||||
propsGuid.textContent = props.GlobalId?.value ?? "";
|
||||
propsPanel.style.display = "";
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Main
|
||||
// -----------------------------------------------------------------------
|
||||
|
|
@ -610,7 +717,29 @@
|
|||
try {
|
||||
const resp = await fetch(toRawUrl(ifcUrl));
|
||||
if (!resp.ok) throw new Error(`HTTP ${resp.status} ${resp.statusText}`);
|
||||
const contentLength = resp.headers.get("Content-Length");
|
||||
const total = contentLength ? parseInt(contentLength, 10) : 0;
|
||||
const reader = resp.body?.getReader();
|
||||
if (reader) {
|
||||
const chunks = [];
|
||||
let received = 0;
|
||||
for (;;) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
chunks.push(value);
|
||||
received += value.length;
|
||||
if (total > 0) {
|
||||
statusEl.textContent = `Fetching… ${Math.round(received * 100 / total)}%`;
|
||||
} else {
|
||||
statusEl.textContent = `Fetching… ${(received / 1048576).toFixed(1)} MB`;
|
||||
}
|
||||
}
|
||||
buffer = new Uint8Array(received);
|
||||
let offset = 0;
|
||||
for (const chunk of chunks) { buffer.set(chunk, offset); offset += chunk.length; }
|
||||
} else {
|
||||
buffer = new Uint8Array(await resp.arrayBuffer());
|
||||
}
|
||||
} catch (err) {
|
||||
statusEl.textContent = `Fetch error: ${err.message}`;
|
||||
return;
|
||||
|
|
@ -645,6 +774,26 @@
|
|||
|
||||
await fragments.core.update(true);
|
||||
|
||||
// Click-to-identify: highlight element and show its properties.
|
||||
try {
|
||||
const highlighter = components.get(OBC.Highlighter);
|
||||
highlighter.setup({ world });
|
||||
highlighter.events.select.onHighlight.add(async (fragmentIdMap) => {
|
||||
for (const expressIds of Object.values(fragmentIdMap)) {
|
||||
const expressId = [...expressIds][0];
|
||||
if (expressId == null) continue;
|
||||
const props = await model.getLocalProperties(expressId);
|
||||
if (props) showPropsPanel(props, ifcLoader.webIfc);
|
||||
return;
|
||||
}
|
||||
});
|
||||
highlighter.events.select.onClear.add(() => {
|
||||
propsPanel.style.display = "none";
|
||||
});
|
||||
} catch (err) {
|
||||
console.warn("Highlighter unavailable:", err.message);
|
||||
}
|
||||
|
||||
syncCameraUrl(threeCamera);
|
||||
cameraControls.addEventListener("rest", () => syncCameraUrl(threeCamera));
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue