{"id":50815332,"url":"https://github.com/mergi72/tc-wfx-plugin","last_synced_at":"2026-06-13T09:01:31.405Z","repository":{"id":362764440,"uuid":"1257093896","full_name":"mergi72/tc-wfx-plugin","owner":"mergi72","description":"Total Commander WFX plugin for DMS Provider Bridge.","archived":false,"fork":false,"pushed_at":"2026-06-12T20:13:06.000Z","size":263,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-12T21:22:42.444Z","etag":null,"topics":["alfresco","bridge","csharp","dms","dotnet","edocat","file-manager","plugin","total-commander","wfx-plugin","windows"],"latest_commit_sha":null,"homepage":"https://github.com/mergi72/dms-provider-bridge","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mergi72.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-02T11:05:44.000Z","updated_at":"2026-06-12T20:13:11.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mergi72/tc-wfx-plugin","commit_stats":null,"previous_names":["mergi72/tc-wfx-plugin"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/mergi72/tc-wfx-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mergi72%2Ftc-wfx-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mergi72%2Ftc-wfx-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mergi72%2Ftc-wfx-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mergi72%2Ftc-wfx-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mergi72","download_url":"https://codeload.github.com/mergi72/tc-wfx-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mergi72%2Ftc-wfx-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34278154,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alfresco","bridge","csharp","dms","dotnet","edocat","file-manager","plugin","total-commander","wfx-plugin","windows"],"created_at":"2026-06-13T09:01:29.935Z","updated_at":"2026-06-13T09:01:31.393Z","avatar_url":"https://github.com/mergi72.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tc-wfx-plugin\n\n[![Status](https://img.shields.io/badge/Status-Alpha-orange)](https://github.com/mergi72/tc-wfx-plugin)\n[![Plugin Version](https://img.shields.io/badge/Plugin-v0.2.5-blue)](https://github.com/mergi72/tc-wfx-plugin)\n[![Installer Release](https://img.shields.io/badge/Installer-v0.3.3--alpha-blueviolet)](https://github.com/mergi72/dms-provider-installer/releases/tag/v0.3.3-alpha)\n\nTotal Commander x64 filesystem plugin for browsing and transferring files through a local `dms-provider-bridge` instance.\n\nUse it to access document repositories exposed by the bridge, such as Alfresco or eDoCat when those providers are configured in the bridge.\n\n## Features\n\n- Browse provider roots and folders from Total Commander.\n- Download files.\n- Upload files, including large streamed uploads.\n- Rename, move, copy, delete, and create folders.\n- Use version-aware uploads when the bridge reports that an existing document needs a new version.\n- Use the same version choice flow for provider-to-provider copy/move into an existing versioned document.\n- Resolve user credentials through `credential-broker` when configured.\n- Load runtime settings from `config.json` next to the plugin.\n\n## Requirements\n\n- Windows x64.\n- Total Commander x64.\n- `dms-provider-installer` for the easiest full-stack installation.\n- A running local `dms-provider-bridge`.\n- Provider and credential configuration in the bridge/broker stack.\n\nLicense: MIT.\n\n## Quick Start\n\n1. Install `dms-provider-installer`.\n2. Make sure the bridge is running at `http://127.0.0.1:8765/health`.\n3. Configure provider credentials using the bridge/broker setup for your environment.\n4. Open Total Commander.\n5. Open the DMS Provider filesystem plugin from Network Neighborhood / WFX plugins.\n6. Select a provider folder and work with files normally.\n\n## How It Works For Users\n\nTotal Commander talks to `TcWfxPlugin.wfx64`. The plugin translates Total Commander paths like `\\provider\\folder` into bridge paths like `provider:/folder`, then calls the local bridge API. The bridge owns provider-specific behavior and talks to the remote DMS.\n\nThis repository does not ship provider implementations. Provider roots are loaded dynamically from:\n\n- `GET /bridge/wfx/providers`\n\n## What This Project Does Not Own\n\n- Bridge installation and Windows service setup.\n- Provider configuration.\n- Provider implementations.\n- Credential Broker installation.\n- Windows Credential Manager entries.\n- Total Commander itself.\n\nThose responsibilities belong to `dms-provider-bridge`, `credential-broker`, `dms-provider-installer`, or Total Commander.\n\n## Developer Overview\n\nSeparated C# repository for the Total Commander WFX plugin that integrates with `dms-provider-bridge`.\n\nCurrent development branch: `develop`  \nStable release branch: `main`\n\nCurrent release mapping:\n\n- Plugin repository latest changelog version: `0.2.5`\n- Latest orchestrator installer release: `dms-provider-installer v0.3.3-alpha`\n- Current tested bridge release: `dms-provider-bridge v0.4.20`\n- Current credential broker release: `credential-broker v0.2.9`\n\n## Related Projects\n\n- `dms-provider-bridge`\n- `credential-broker`\n- `dms-provider-installer`\n\n## Developer Scope\n\nCurrent status:\n- Provider support is owned by `dms-provider-bridge`.\n- Root providers are resolved dynamically from `GET /bridge/wfx/providers`.\n- This repository does not hardcode or ship provider implementations.\n- Credential resolution can use `credential-broker` when configured.\n\nCurrent intended flow:\n- Total Commander WFX plugin -\u003e credential broker for user credentials when needed -\u003e bridge -\u003e provider.\n- Bridge and broker installation are owned by their dedicated installers; the orchestrator installer bundles them with the WFX plugin.\n\n## Automation\n\n- CI workflow: `.github/workflows/ci.yml` (restore, build, test on push/PR)\n- Release artifact workflow: `.github/workflows/release-artifact.yml` (manual run or tag `v*`)\n- Release workflow gating: when secret `BRIDGE_REPO_TOKEN` is set, release first runs bridge integration smoke and publishes artifact only if smoke succeeds.\n- Integration smoke workflow job starts local `dms-provider-bridge`, validates `GET /health`, `GET /bridge/wfx/providers`, `POST /bridge/wfx/list`, and can perform streamed large upload smoke via `POST /bridge/wfx/upload-raw` when a suitable bridge provider/path is configured.\n\t- For cross-repo checkout in GitHub Actions, configure secret `BRIDGE_REPO_TOKEN` (read access to `mergi72/dms-provider-bridge`).\n- Branch protection helper: CI publishes final job `protection-gate` that summarizes required job outcomes.\n  - Recommended GitHub branch rule for `main`: require status check `protection-gate`.\n\t- If GitHub plan does not allow branch protection for private repositories, use process fallback: no direct pushes to `main`; merge only via PR after successful `protection-gate`.\n\n## Release Notes\n\n- See `CHANGELOG.md` for release history and `v0.2.5` notes.\n- For first external testing scope, see `RELEASE_NOTES_v0.1.0-alpha.md`.\n\n## License\n\n- MIT (`LICENSE`)\n\n## Structure\n\n- `src/TcWfxPlugin/Contracts/` - request/response DTO contracts aligned with bridge endpoints\n- `src/TcWfxPlugin/Core/` - shared domain helpers (provider path parsing/validation)\n- `src/TcWfxPlugin/Bridge/` - bridge client abstraction interfaces\n- `src/TcWfxPlugin/Wfx/` - WFX-oriented facade for plugin operations\n- `src/TcWfxPlugin/WfxBridgeClient.cs` - concrete HTTP client implementation for `/bridge/wfx/*`\n- `tests/TcWfxPlugin.Tests/` - xUnit tests for core parsing and facade behavior\n\n## WFX Runtime Skeleton\n\n- `WfxPluginRuntime` implements WFX-like operations for listing, iterating, mkdir, delete, rename, copy, download, and upload.\n- `WfxEntryPoints` exposes sync wrappers (`FsFindFirst`, `FsFindNext`, `FsFindClose`, `FsMkDir`, `FsDeleteFile`, `FsRenMovFile`, `FsGetFile`, `FsPutFile`).\n- `IWfxAuthProvider` decouples credential retrieval from runtime operations.\n- `TcDialogAuthProvider` resolves credentials through environment defaults, credential broker, or Total Commander prompts.\n- `EnvironmentAuthProvider` remains available for tests and direct embedding scenarios.\n- `TotalCommanderPathMapper` translates Total Commander-style paths (`\\provider\\path`) to bridge provider paths (`provider:/path`).\n- Root listing (`\\` and `\\*.*`) is served as provider folders resolved dynamically from `GET /bridge/wfx/providers`.\n- Wildcard listing masks in paths (for example `\\provider\\folder\\*.*`) are normalized to directory provider paths.\n- Root provider list is cached with TTL to reduce bridge calls during panel navigation.\n- Root providers come from the bridge response. If `TC_WFX_PROVIDERS` is set, it overrides the bridge response. If the bridge is unavailable and no cache is present, the root listing stays empty instead of falling back to hardcoded providers.\n- Find contexts are cleaned up automatically by idle TTL and bounded by maximum context count to prevent handle leaks.\n- Existing-document upload can handle bridge `version_required` responses and ask for major/minor version selection.\n- Large uploads use streamed multipart `upload-raw`; downloads use raw streaming where available.\n\n## Native Exports\n\n- `WfxNativeExports` defines unmanaged entrypoints with `UnmanagedCallersOnly`:\n\t- `FsInitW`\n\t- `FsFindFirstW`\n\t- `FsFindNextW`\n\t- `FsFindClose`\n\t- `FsMkDirW`\n\t- `FsDeleteFileW`\n\t- `FsRenMovFileW`\n\t- `FsGetFileW`\n\t- `FsPutFileW`\n\n## Environment Configuration\n\n- `TC_WFX_BRIDGE_URL` (default: `http://127.0.0.1:8765/`)\n- `TC_WFX_AUTH_MODE` (`winuser` or `credentials`)\n- `TC_WFX_WIN_USER`\n- `TC_WFX_CREDENTIAL_ID`\n- `TC_WFX_USERNAME`\n- `TC_WFX_PASSWORD`\n- `TC_WFX_TOKEN`\n- `TC_WFX_CREDENTIAL_BROKER_URL` (default credential broker endpoint)\n- `TC_WFX_CREDENTIAL_BROKER_TIMEOUT_MS` (credential broker request timeout)\n- `TC_WFX_PROVIDERS` (optional comma/semicolon-separated root provider override; when missing, providers are resolved from bridge)\n- `TC_WFX_PROVIDERS_CACHE_SECONDS` (optional TTL for cached root providers loaded from bridge; default `30`, `0` disables cache)\n- `TC_WFX_FIND_CONTEXT_TTL_SECONDS` (optional TTL for inactive find contexts; default `600`, `0` disables TTL cleanup)\n- `TC_WFX_MAX_FIND_CONTEXTS` (optional hard limit for concurrently tracked find contexts; default `512`)\n- `TC_WFX_PROGRESS_STEPS` (optional fallback number of progress buckets for TC callback throttling; default `10`, allowed range `1..100`)\n\nAdditional optional env fallbacks:\n\n- `TC_WFX_BRIDGE_TIMEOUT_SECONDS` (fallback bridge HTTP timeout in seconds)\n- `TC_WFX_LOGGING_ENABLED` (fallback `true/false` toggle for diagnostic logs)\n- `TC_WFX_LOG_DIR` (fallback log directory; absolute or relative to plugin directory)\n\nOptional runtime file configuration (preferred for progress):\n\n- Place `config.json` next to `TcWfxPlugin.wfx64`.\n- Repository ships a ready template at `config/config.json`.\n- Configure progress buckets via:\n\n```json\n{\n\t\"progress\": {\n\t\t\"steps\": 10\n\t}\n}\n```\n\nResolution order for progress steps:\n\n1. `config.json` -\u003e `progress.steps`\n2. `TC_WFX_PROGRESS_STEPS`\n3. default `10`\n\nResolution order for runtime settings in general:\n\n1. `config.json`\n2. corresponding environment variable\n3. built-in default\n\nSupported `config.json` keys:\n\n```json\n{\n\t\"bridge\": {\n\t\t\"url\": \"http://127.0.0.1:8765/\",\n\t\t\"timeoutSeconds\": 900\n\t},\n\t\"progress\": {\n\t\t\"steps\": 10\n\t},\n\t\"logging\": {\n\t\t\"enabled\": true,\n\t\t\"path\": \"logs\"\n\t}\n}\n```\n\n`config.json` can be placed either next to `TcWfxPlugin.wfx64` or in `config/config.json` under the plugin directory.\n\nThe publish script automatically copies repository template `config/config.json` to artifact output `config/config.json`.\n\nCache can also be invalidated explicitly through `WfxEntryPoints.InvalidateProvidersCache()`.\n\n## Bridge Endpoints Targeted\n\n- `GET /bridge/wfx/providers`\n- `POST /bridge/wfx/list`\n- `POST /bridge/wfx/stat`\n- `POST /bridge/wfx/mkdir`\n- `POST /bridge/wfx/delete`\n- `POST /bridge/wfx/move`\n- `POST /bridge/wfx/copy`\n- `POST /bridge/wfx/download`\n- `POST /bridge/wfx/download-raw`\n- `POST /bridge/wfx/upload`\n- `POST /bridge/wfx/upload-raw`\n- `POST /bridge/wfx/upload-stream` (bridge alias for streamed raw upload)\n\nUpload requests can include bridge `versioning` data with `majorVersion` when the bridge asks for a new version decision.\n\n## Notes\n\n- Build and test:\n\n```powershell\ndotnet build\ndotnet test\n```\n\n- Native AOT publish (WFX DLL):\n\n```powershell\n./scripts/publish-wfx.ps1\n```\n\nor directly:\n\n```powershell\ndotnet publish src/TcWfxPlugin/TcWfxPlugin.csproj --configuration Release -r win-x64 /p:PublishAot=true /p:NativeLib=Shared --output artifacts/TcWfxPlugin-win-x64\n```\n\n- Bridge integration smoke (local):\n\n```powershell\n./scripts/run-bridge-smoke.ps1 -BridgeRepoPath ../dms-provider-bridge\n```\n\n- Runtime config smoke (local):\n\n```powershell\n./scripts/run-runtime-config-smoke.ps1\n```\n\nThis smoke validates config template presence/shape and runs focused tests that verify runtime config loading, including `logging.enabled=false`.\n\nOptional parameters:\n\n- `-LargeUploadMB 176` enables large streamed upload smoke (set `0` to skip)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmergi72%2Ftc-wfx-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmergi72%2Ftc-wfx-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmergi72%2Ftc-wfx-plugin/lists"}