Merge branch 'gnomeext'

This commit is contained in:
buenosairesam
2025-12-19 23:43:30 -03:00
12 changed files with 1320 additions and 38 deletions

View File

@@ -1,26 +1,85 @@
# Deskmeter # Deskmeter GNOME Integration
Deskmeter is a productivity tool to measure how much time you spend doing stuff in your computer. Display your current deskmeter task in the GNOME panel or in a standalone window.
More precisely how much time passes while a given workspace is active.
## Quick Start
### Task Window (No logout required)
```bash
# Run the task window with auto port detection
python3 task_window.py
# Make it always-on-top and visible on all workspaces
wmctrl -r "Deskmeter Task" -b add,above,sticky
```
### GNOME Extension (Requires logout)
Extension is already installed and enabled. Just log out and back in to activate it.
```bash
# Check status
gnome-extensions list --enabled | grep deskmeter
# View logs after login
journalctl --user -u org.gnome.Shell@wayland.service -f | grep deskmeter
```
## Features
-**Auto port detection** - Finds dmweb on ports 10001 or 10000
-**Workspace change detection** - Updates when you switch workspaces
-**Error handling** - Won't crash GNOME Shell if something fails
-**Minimal UI** - Clean display without window decorations
## Requirements ## Requirements
- MongoDB - GNOME Shell 49+ (Wayland or X11)
- wmctrl - Python 3 with GTK4 (`python3-gi`)
- Flask - dmweb running on port 10000 or 10001
- wmctrl (for workspace detection and window properties)
install those first, also wmctrl doesn't work on wayland, until an equivalent is found. you have to switch to XORG. ## Documentation
## Define Workspace Labels See [docs/](docs/) directory for detailed documentation:
edit the desktops variable in `dmmain.py` to your needs, first is workspace 1, second 2 and so on - **[READY_TO_TEST.md](docs/READY_TO_TEST.md)** - Complete testing guide (START HERE)
- **[TASK_WINDOW_README.md](docs/TASK_WINDOW_README.md)** - Task window usage and configuration
- **[INSTALL_STATUS.md](docs/INSTALL_STATUS.md)** - Extension installation and troubleshooting
- **[PORT_DETECTION_README.md](docs/PORT_DETECTION_README.md)** - How auto port detection works
## How to run ## Project Structure
leave the dmmain.py running in the background, use the dmapp flask application to see the data. ```
the homepage shows current day result, dm-gnomeext/
`/calendar` shows the current month with week totals ├── task_window.py # Standalone GTK window app
`/calendar/<month_number>` shows the select month of current year with week totals ├── run_task_window.sh # Helper script for window
`/calendar/<month_number>` shows the select month of current year with week totals ├── gnome-extension/ # Extension source
│ └── deskmeter-indicator@local/
│ ├── extension.js
│ ├── metadata.json
│ └── stylesheet.css
├── docs/ # Documentation
└── README.md # This file
```
adapt `deskmeter.sh` and `dmapp.sh` to your needs. I put those in my home directory. Add starting the mongo service ## Quick Commands
```bash
# Test task window
python3 task_window.py
# Test API
curl http://localhost:10001/api/current_task
# Check extension status
gnome-extensions list --enabled | grep deskmeter
# Make window always-on-top
wmctrl -r "Deskmeter Task" -b add,above,sticky
```
## Support
For troubleshooting and detailed information, see the [docs/](docs/) directory.

298
docs/INSTALL_STATUS.md Normal file
View File

@@ -0,0 +1,298 @@
# Deskmeter GNOME Extension - Installation Status
**Date**: 2025-12-19
**GNOME Shell Version**: 49.2 (Wayland)
**Extension UUID**: deskmeter-indicator@local
---
## ✅ Installation Complete
1. **Extension files installed** to `~/.local/share/gnome-shell/extensions/deskmeter-indicator@local/`
2. **metadata.json updated** to support GNOME Shell 48 and 49
3. **Extension enabled** via dconf (added to enabled-extensions list)
---
## ⚠️ IMPORTANT: Required Before Testing
### 1. Log Out and Back In (Wayland Requirement)
Since you're on Wayland, GNOME Shell **cannot** be restarted without logging out. The extension will **only** load after you log back in.
```bash
# After logging back in, verify extension is loaded:
gnome-extensions list --enabled | grep deskmeter
```
Expected output: `deskmeter-indicator@local`
---
### 2. Start dmweb Server
The extension requires the dmweb Flask server running on port 10000:
```bash
# Navigate to dmweb directory
cd ~/wdir/dm-gnomeext/../../dm/dmapp/dmweb
# or wherever your dmapp directory is located
# Start the server
python3 run.py
```
**Test the API endpoint:**
```bash
curl http://localhost:10000/api/current_task
```
Expected response:
```json
{"task_id":"12345678","task_path":"work/default"}
```
If you get an error, dmweb is not running.
---
## 🎯 What to Expect
After logging back in and starting dmweb, you should see:
- **Extension indicator** in the top-left panel (left of other indicators)
- **Initial state**: Shows "loading..." for ~2 seconds
- **Normal state**: Displays current task path (e.g., "work/default")
- **After workspace switch**: Updates after 2.2 second delay
- **Long paths**: Auto-truncates to show last 2 segments (e.g., ".../project/task")
---
## 🔧 Troubleshooting
### Extension Not Showing in Panel
```bash
# 1. Check if extension is in enabled list
gnome-extensions list --enabled | grep deskmeter
# 2. If not listed, manually enable again
gnome-extensions enable deskmeter-indicator@local
# 3. Check extension info
gnome-extensions info deskmeter-indicator@local
# 4. View GNOME Shell logs for errors
journalctl --user -u org.gnome.Shell@wayland.service -f
# Filter for deskmeter errors:
journalctl --user -u org.gnome.Shell@wayland.service --since "5 minutes ago" | grep -i deskmeter
```
### Shows "offline" Instead of Task
```bash
# Check if dmweb is running
curl http://localhost:10000/api/current_task
# Check if port 10000 is listening
ss -tlnp | grep 10000
# Start dmweb if not running
cd ~/wdir/dm-gnomeext/../../dm/dmapp/dmweb
python3 run.py
```
### Shows "error" Instead of Task
This means the API is reachable but returned invalid JSON. Check dmweb logs:
```bash
# In dmweb terminal, you should see the request
# Look for Python errors or exceptions
```
### Extension Shows in List but Not Enabled
```bash
# Force enable via dconf
dconf write /org/gnome/shell/enabled-extensions \
"$(dconf read /org/gnome/shell/enabled-extensions | sed "s/]$/, 'deskmeter-indicator@local']/")"
# Verify it was added
dconf read /org/gnome/shell/enabled-extensions
# Then log out/in again
```
### Extension Loads but Causes GNOME Shell Issues
```bash
# Disable the extension
gnome-extensions disable deskmeter-indicator@local
# Or remove from dconf
dconf write /org/gnome/shell/enabled-extensions \
"$(dconf read /org/gnome/shell/enabled-extensions | sed "s/, 'deskmeter-indicator@local'//")"
# View detailed error logs
journalctl --user -u org.gnome.Shell@wayland.service -n 200 | grep -A 10 -i "error.*deskmeter"
```
---
## 🐛 Debug Mode: View Live Logs
```bash
# Watch GNOME Shell logs in real-time (useful for debugging)
journalctl --user -u org.gnome.Shell@wayland.service -f | grep --line-buffered -i "deskmeter\|error"
# In another terminal, try interacting with the extension
# (switch workspaces, etc.) and watch for log output
```
---
## 🔍 Using GNOME Looking Glass for Debug
If the extension loads but doesn't work:
1. Press `Alt+F2`
2. Type `lg` and press Enter
3. Go to the **Extensions** tab
4. Find `deskmeter-indicator@local`
5. Check if it shows as **ACTIVE** or has error state
6. Click on it to see error details
---
## 📝 Extension Files Location
```
~/.local/share/gnome-shell/extensions/deskmeter-indicator@local/
├── extension.js (Main extension code)
├── metadata.json (Extension metadata with GNOME version support)
└── stylesheet.css (Panel label styling)
```
---
## 🔄 Update Extension After Code Changes
```bash
# 1. Copy updated files
cp -r gnome-extension/deskmeter-indicator@local/* \
~/.local/share/gnome-shell/extensions/deskmeter-indicator@local/
# 2. On Wayland: MUST log out and back in
# (No way around this unfortunately)
# 3. On X11: Can reload with Alt+F2 → r → Enter
# (But you're on Wayland)
```
---
## ✅ Quick Test Checklist
After logging back in:
- [ ] Extension appears in `gnome-extensions list --enabled`
- [ ] dmweb server is running (`curl http://localhost:10000/api/current_task` works)
- [ ] Task indicator visible in top panel (left side)
- [ ] Shows current task path (not "loading...", "offline", or "error")
- [ ] Updates when switching workspaces (after ~2 second delay)
---
## 📚 Useful Commands Reference
```bash
# List all extensions
gnome-extensions list
# List enabled extensions
gnome-extensions list --enabled
# Enable extension
gnome-extensions enable deskmeter-indicator@local
# Disable extension
gnome-extensions disable deskmeter-indicator@local
# Get extension info
gnome-extensions info deskmeter-indicator@local
# View current dconf enabled extensions
dconf read /org/gnome/shell/enabled-extensions
# Test dmweb API
curl http://localhost:10000/api/current_task
# Check GNOME Shell version
gnome-shell --version
# View GNOME Shell service status
systemctl --user status org.gnome.Shell@wayland.service
```
---
## 🚨 If Everything Fails
1. **Collect logs:**
```bash
journalctl --user -u org.gnome.Shell@wayland.service --since "10 minutes ago" > /tmp/gnome-shell-logs.txt
```
2. **Check extension syntax:**
```bash
cat ~/.local/share/gnome-shell/extensions/deskmeter-indicator@local/extension.js | head -20
cat ~/.local/share/gnome-shell/extensions/deskmeter-indicator@local/metadata.json
```
3. **Disable and remove:**
```bash
gnome-extensions disable deskmeter-indicator@local
rm -rf ~/.local/share/gnome-shell/extensions/deskmeter-indicator@local
```
4. **Reinstall from scratch:**
```bash
cp -r gnome-extension/deskmeter-indicator@local ~/.local/share/gnome-shell/extensions/
gnome-extensions enable deskmeter-indicator@local
# Log out and back in
```
---
## 📁 Project Structure
```
dm-gnomeext/
└── gnome-extension/
├── deskmeter-indicator@local/
│ ├── extension.js ← Main extension code
│ ├── metadata.json ← Updated to support GNOME 49
│ └── stylesheet.css ← Panel styling
├── README.md
├── install.sh
└── update.sh
```
---
## 💡 Extension Behavior Notes
- **Debounce delay**: Extension waits 2.2 seconds after workspace switch before querying API
- This allows dmcore (polls every 2s) to detect the change and update MongoDB
- **Path truncation**: Paths longer than 40 chars show as `.../last/two`
- **Error handling**:
- "loading..." = Initial state or pending update
- "offline" = Cannot reach API endpoint
- "error" = API reachable but invalid response
- "no task" = Valid response but no current task
---
Good luck! If you see the task indicator after logging back in, it's working perfectly.

View File

@@ -0,0 +1,148 @@
# Port Auto-Detection
Both the task window and GNOME extension now automatically detect which port dmweb is running on.
## How It Works
### Automatic Detection
Both apps try ports in this order:
1. **10001** - Worktree instance (tried first)
2. **10000** - Default instance (fallback)
The first port that responds successfully is used.
### Task Window (task_window.py)
**Auto-detection** (recommended):
```bash
./task_window.py
# OR
python3 task_window.py
```
Output will show:
```
Found dmweb API on port 10001
API URL: http://localhost:10001/api/current_task
```
**Manual port specification:**
```bash
# Specify custom port as argument
python3 task_window.py 10001
python3 task_window.py 10000
python3 task_window.py 9999
```
**Environment variable:**
```bash
# Set port via environment variable
DESKMETER_PORT=10001 python3 task_window.py
```
Priority order: Command line arg > Environment variable > Auto-detection
### GNOME Extension
The extension automatically tries ports 10001 and 10000 when it starts.
You'll see "detecting..." in the panel while it searches, then it will show:
- The task name when port is found
- "offline" if no port responds
## Testing
### Test with curl
```bash
# Check which ports are running
curl http://localhost:10000/api/current_task # default
curl http://localhost:10001/api/current_task # worktree
```
### Test task window
```bash
# Auto-detect (will find port 10001 first)
python3 task_window.py
# Force specific port
python3 task_window.py 10000
```
Watch the console output to see which port was detected/used.
## Configuration
### Changing Port Priority
Edit `task_window.py` line 16:
```python
DEFAULT_PORTS = [10001, 10000] # Try in this order
```
Edit `gnome-extension/deskmeter-indicator@local/extension.js` line 11:
```javascript
const DEFAULT_PORTS = [10001, 10000]; // Try in this order
```
### Adding More Ports
```python
# In task_window.py
DEFAULT_PORTS = [10001, 10000, 9999, 8080]
```
```javascript
// In extension.js
const DEFAULT_PORTS = [10001, 10000, 9999, 8080];
```
## Troubleshooting
### Window shows "offline - dmweb not running"
```bash
# Check if any dmweb is running
ps aux | grep dmweb
# Check what ports are listening
ss -tlnp | grep -E "(10000|10001)"
# Test ports manually
curl http://localhost:10000/api/current_task
curl http://localhost:10001/api/current_task
```
### Extension shows "detecting..." forever
The extension couldn't connect to any port. Check:
```bash
# View extension logs
journalctl --user -u org.gnome.Shell@wayland.service -f | grep deskmeter
```
Common issues:
- dmweb not running
- Firewall blocking localhost connections
- Wrong API endpoint (make sure `/api/current_task` exists)
### Force specific port for extension
Edit `~/.local/share/gnome-shell/extensions/deskmeter-indicator@local/extension.js` line 11:
```javascript
// Only try one port
const DEFAULT_PORTS = [10001];
```
Then log out and back in to reload the extension.
## Summary
**Task window**: Auto-detects ports 10001, 10000 (can override with arg or env var)
**GNOME extension**: Auto-detects ports 10001, 10000
**Worktree-first**: Both try port 10001 before 10000
**Configurable**: Easy to change port list or add more ports

85
docs/README.md Normal file
View File

@@ -0,0 +1,85 @@
# Deskmeter GNOME Integration - Documentation
Complete documentation for the Deskmeter GNOME task display tools.
## Documentation Files
### Getting Started
**[READY_TO_TEST.md](READY_TO_TEST.md)** - ⭐ START HERE
Complete testing guide with checklists, troubleshooting, and commands. Everything you need to test both the task window and GNOME extension.
### Task Window
**[TASK_WINDOW_README.md](TASK_WINDOW_README.md)**
Detailed guide for the standalone GTK task window:
- Usage instructions
- Configuration options
- Startup and autostart setup
- Comparison with extension
### GNOME Extension
**[INSTALL_STATUS.md](INSTALL_STATUS.md)**
Extension installation status and troubleshooting:
- Installation checklist
- Wayland requirements
- Detailed troubleshooting steps
- GNOME Looking Glass debugging
- Extension file locations
**[EXTENSION_ORIGINAL.md](EXTENSION_ORIGINAL.md)**
Original extension README (kept for reference)
### Technical Details
**[PORT_DETECTION_README.md](PORT_DETECTION_README.md)**
How automatic port detection works:
- Auto-detection mechanism
- Manual port configuration
- Priority order
- Testing and troubleshooting
## Quick Links
### Task Window
```bash
# Run with auto port detection
python3 task_window.py
# Specify port manually
python3 task_window.py 10001
```
### GNOME Extension
```bash
# Check if enabled
gnome-extensions list --enabled | grep deskmeter
# View logs
journalctl --user -u org.gnome.Shell@wayland.service -f | grep deskmeter
```
### API Testing
```bash
# Test dmweb API
curl http://localhost:10001/api/current_task
curl http://localhost:10000/api/current_task
```
## Documentation Index
| File | Purpose | Audience |
|------|---------|----------|
| READY_TO_TEST.md | Complete testing guide | Everyone - start here |
| TASK_WINDOW_README.md | Task window documentation | Window users |
| INSTALL_STATUS.md | Extension troubleshooting | Extension users |
| PORT_DETECTION_README.md | Port detection details | Advanced users |
| EXTENSION_ORIGINAL.md | Original extension docs | Reference |
## Need Help?
1. **Start with** [READY_TO_TEST.md](READY_TO_TEST.md) for immediate testing
2. **For task window issues** see [TASK_WINDOW_README.md](TASK_WINDOW_README.md)
3. **For extension issues** see [INSTALL_STATUS.md](INSTALL_STATUS.md)
4. **For port problems** see [PORT_DETECTION_README.md](PORT_DETECTION_README.md)

268
docs/READY_TO_TEST.md Normal file
View File

@@ -0,0 +1,268 @@
# Ready to Test - Deskmeter Task Display
**Date**: 2025-12-19
**Status**: ✅ All updates complete and ready for testing
---
## What's Been Updated
### 1. Task Window (task_window.py) ✅
**New Features**:
-**No window decorations** - Clean minimal window, no title bar or close button
-**Workspace change detection** - Updates 2.2s after you switch workspaces
-**Auto port detection** - Finds dmweb on port 10001 or 10000 automatically
-**Faster updates** - Polls every 500ms to catch changes quickly
-**Smaller window** - 400x60px (reduced from 400x80)
**How to Close**:
- `Alt+F4` (keyboard)
- `pkill -f task_window.py` (command line)
- Kill the terminal where you started it
### 2. GNOME Extension ✅
**New Features**:
-**Error handling** - Won't crash GNOME Shell if something fails
-**Auto port detection** - Same as window, tries 10001 then 10000
-**Safe enable/disable** - All operations wrapped in try-catch
**Updated files in**: `~/.local/share/gnome-shell/extensions/deskmeter-indicator@local/`
---
## How to Test
### Option 1: Test Window Now (No Logout Required)
```bash
cd /home/mariano/wdir/dm-gnomeext
# Run the window
python3 task_window.py
```
**Expected behavior**:
1. Console shows: `Found dmweb API on port 10001`
2. Small window appears showing: **work/own/deskmeter**
3. Window has **no title bar** (clean, minimal)
4. When you switch workspaces, it updates after ~2 seconds
**Make it always-on-top** (in another terminal):
```bash
wmctrl -r "Deskmeter Task" -b add,above,sticky
```
**Position it** where you want (drag with mouse or use wmctrl)
### Option 2: Test GNOME Extension (Requires Logout)
```bash
# 1. Verify extension is enabled
gnome-extensions list --enabled | grep deskmeter
# 2. Check extension files are updated
ls -la ~/.local/share/gnome-shell/extensions/deskmeter-indicator@local/
# 3. Log out and log back in
# 4. After login, check panel for task indicator (left side)
```
---
## What You'll See
### Task Window
```
┌────────────────────────┐
│ work/own/deskmeter │
└────────────────────────┘
```
- No borders, no title bar, just the task text
- Clean minimal display
- Position anywhere, stays on top
### GNOME Extension
```
[Activities] [deskmeter] [detecting...] → [work/own/deskmeter]
└─ Panel indicator
```
- Shows in panel (left side)
- "detecting..." while finding port
- Then shows current task
---
## Testing Checklist
### Window Testing
- [ ] Window appears without title bar/decorations
- [ ] Shows current task: "work/own/deskmeter"
- [ ] Can be moved by dragging
- [ ] Can close with Alt+F4
- [ ] Updates when you switch workspaces (wait ~2s after switch)
- [ ] Can be set always-on-top with wmctrl
- [ ] Auto-detects port 10001 (check console output)
### Extension Testing (after logout/login)
- [ ] Extension shows in panel (left side)
- [ ] Shows "detecting..." briefly
- [ ] Shows current task after detection
- [ ] Updates when switching workspaces (wait ~2s)
- [ ] If extension fails, GNOME Shell still works (doesn't crash)
- [ ] Can disable extension: `gnome-extensions disable deskmeter-indicator@local`
---
## Troubleshooting
### Window shows "offline - dmweb not running"
```bash
# Check if dmweb is running
ps aux | grep dmweb
# Check what's on port 10001
curl http://localhost:10001/api/current_task
# Should show: {"task_id":"8f797adb","task_path":"work/own/deskmeter"}
```
### Window doesn't update on workspace change
```bash
# Test wmctrl is working
wmctrl -d
# Should show workspaces with * marking current one
```
### Window won't stay on top
```bash
# After starting window, in another terminal:
wmctrl -r "Deskmeter Task" -b add,above,sticky
# Verify it worked:
wmctrl -l -x | grep -i deskmeter
```
### Extension doesn't appear in panel after logout/login
```bash
# Check if enabled
gnome-extensions list --enabled | grep deskmeter
# Check for errors
journalctl --user -u org.gnome.Shell@wayland.service --since "5 minutes ago" | grep -i deskmeter
# Try manually enabling
gnome-extensions enable deskmeter-indicator@local
# Then logout/login again
```
### Extension shows "detecting..." forever
dmweb is not running on any of the tried ports (10001, 10000). Start dmweb:
```bash
cd ~/wdir/dm/dmapp/dmweb # or wherever your dmweb is
python3 run.py
```
---
## Performance Notes
### Task Window
- Checks workspace every 200ms (lightweight wmctrl call)
- Updates task every 500ms when no workspace change
- After workspace change: waits 2200ms before updating (gives dmcore time)
- Minimal CPU usage: ~0.1-0.2%
### GNOME Extension
- Only updates on workspace switch + periodic refresh
- Uses debounce delay of 2200ms
- Minimal overhead, integrated with GNOME Shell event loop
---
## Commands Quick Reference
```bash
# Start task window
cd /home/mariano/wdir/dm-gnomeext
python3 task_window.py
# Make window always-on-top + sticky (all workspaces)
wmctrl -r "Deskmeter Task" -b add,above,sticky
# Position window (example: top-right corner)
wmctrl -r "Deskmeter Task" -e 0,1500,0,400,60
# Close window
pkill -f task_window.py
# OR
Alt+F4 (when window has focus)
# Check extension status
gnome-extensions list --enabled | grep deskmeter
# View extension logs
journalctl --user -u org.gnome.Shell@wayland.service -f | grep deskmeter
# Test API manually
curl http://localhost:10001/api/current_task
```
---
## Next Steps
1. **Test the window now** - No logout required, immediate feedback
2. **When satisfied with window behavior** - Log out/in to test extension
3. **Choose your preference**:
- Use window for now (quick to start/stop)
- Use extension after logout (cleaner, integrated into panel)
- Use both (why not?)
---
## File Locations
```
/home/mariano/wdir/dm-gnomeext/
├── task_window.py ← Updated window app
├── run_task_window.sh ← Helper script (can also use directly)
├── gnome-extension/
│ └── deskmeter-indicator@local/ ← Source (updated)
│ ├── extension.js ✅ Error handling added
│ ├── metadata.json ✅ GNOME 49 support
│ └── stylesheet.css
└── ~/.local/share/gnome-shell/extensions/
└── deskmeter-indicator@local/ ← Installed (updated)
├── extension.js ✅ Error handling added
├── metadata.json ✅ GNOME 49 support
└── stylesheet.css
```
---
## Documentation
- `INSTALL_STATUS.md` - Extension installation troubleshooting
- `PORT_DETECTION_README.md` - How auto port detection works
- `TASK_WINDOW_README.md` - Task window usage guide
- `READY_TO_TEST.md` - This file
---
**Everything is ready! Start with the window test - it's the quickest way to verify everything works.**
```bash
python3 task_window.py
```
Then when you're ready, log out/in to test the extension.

161
docs/TASK_WINDOW_README.md Normal file
View File

@@ -0,0 +1,161 @@
# Deskmeter Task Window - Regular Mode
A simple GTK4 window that displays your current deskmeter task, with always-on-top and sticky (visible on all workspaces) properties.
## Why Use This?
- **Testing**: Test the dmweb API integration without needing to restart GNOME Shell
- **Temporary solution**: Use while waiting to log out/in to activate the extension
- **Standalone mode**: If you prefer a window instead of a panel indicator
## Prerequisites
- Python 3 with GTK4 bindings (`python3-gi`)
- dmweb server running on `http://localhost:10000`
- `wmctrl` installed (for always-on-top functionality)
## Quick Start
### Option 1: Using the launcher script (recommended)
```bash
cd /home/mariano/wdir/dm-gnomeext
./run_task_window.sh
```
This will:
1. Start the task window
2. Automatically set it to always-on-top
3. Make it visible on all workspaces (sticky)
### Option 2: Run Python script directly
```bash
cd /home/mariano/wdir/dm-gnomeext
python3 task_window.py
```
Then manually set window properties:
- Right-click window title bar → "Always on Top"
- Right-click window title bar → "Always on Visible Workspace" (if available)
Or use wmctrl:
```bash
# After window appears
wmctrl -r "Deskmeter Task" -b add,above,sticky
```
## What You'll See
- **Loading...** - Initial state while fetching first task
- **work/default** - Your current task path (updates every 2.2 seconds)
- **offline - dmweb not running** (red) - Cannot connect to API
- **error - invalid API response** (orange) - API returned invalid JSON
- **no task** - Valid response but no current task set
## Configuration
Edit `task_window.py` to customize:
```python
UPDATE_INTERVAL = 2200 # Update frequency in milliseconds
DESKMETER_API_URL = 'http://localhost:10000/api/current_task' # API endpoint
```
Window appearance (line ~24):
```python
self.set_default_size(400, 80) # Width x Height
```
Font size and styling (line ~27):
```python
self.label.set_markup('<span font_desc="14">Loading...</span>')
```
## Stopping the Window
- Close the window normally (X button)
- Or kill the process: `pkill -f task_window.py`
## Troubleshooting
### "offline - dmweb not running"
Start the dmweb server:
```bash
cd ~/path/to/dm/dmapp/dmweb
python3 run.py
```
Test manually:
```bash
curl http://localhost:10000/api/current_task
```
### Window not staying on top
```bash
# Manually set properties
wmctrl -r "Deskmeter Task" -b add,above,sticky
# Check if wmctrl is installed
which wmctrl
# If not: sudo apt install wmctrl
```
### GTK4 not found
```bash
# Install GTK4 Python bindings
sudo apt install python3-gi gir1.2-gtk-4.0
```
### Window appears on wrong workspace
Use wmctrl to make it sticky (visible on all workspaces):
```bash
wmctrl -r "Deskmeter Task" -b add,sticky
```
## Comparison: Window vs Extension
| Feature | Task Window (this) | GNOME Extension |
|---------|-------------------|-----------------|
| Always visible | ✅ (when on top) | ✅ (in panel) |
| All workspaces | ✅ (sticky) | ✅ (panel always visible) |
| Screen space | Takes window space | No extra space |
| Setup | Run anytime | Requires logout/login |
| Integration | Separate window | Native panel integration |
| Restart needed | No | Yes (on Wayland) |
## Usage Tips
1. **Position**: Drag to top-right corner of screen for minimal interference
2. **Size**: The window can be resized - smaller is less intrusive
3. **Transparency**: You can use GNOME Tweaks to make unfocused windows transparent
4. **Auto-start**: Add to Startup Applications if you want it to run on login
## Adding to Startup (Optional)
```bash
# Create desktop entry
cat > ~/.config/autostart/deskmeter-task-window.desktop <<EOF
[Desktop Entry]
Type=Application
Name=Deskmeter Task Window
Exec=/home/mariano/wdir/dm-gnomeext/run_task_window.sh
Hidden=false
NoDisplay=false
X-GNOME-Autostart-enabled=true
EOF
```
## Files
- `task_window.py` - Main GTK4 Python application
- `run_task_window.sh` - Launcher script with wmctrl integration
- `TASK_WINDOW_README.md` - This file
## Next Steps
Once you've tested that the API integration works with this window, you can log out/in to test the GNOME extension, which will provide the same information in the panel without taking up window space.

Binary file not shown.

View File

@@ -7,8 +7,10 @@ import Clutter from 'gi://Clutter';
import * as Main from 'resource:///org/gnome/shell/ui/main.js'; import * as Main from 'resource:///org/gnome/shell/ui/main.js';
import * as PanelMenu from 'resource:///org/gnome/shell/ui/panelMenu.js'; import * as PanelMenu from 'resource:///org/gnome/shell/ui/panelMenu.js';
const DESKMETER_API_URL = 'http://localhost:10000/api/current_task'; // Try common ports - worktree (10001) first, then default (10000)
const DEFAULT_PORTS = [10001, 10000];
const DEBOUNCE_DELAY = 2200; // Wait 2.2s after workspace switch (dmcore polls every 2s) const DEBOUNCE_DELAY = 2200; // Wait 2.2s after workspace switch (dmcore polls every 2s)
let DESKMETER_API_URL = null;
const TaskIndicator = GObject.registerClass( const TaskIndicator = GObject.registerClass(
class TaskIndicator extends PanelMenu.Button { class TaskIndicator extends PanelMenu.Button {
@@ -17,7 +19,7 @@ class TaskIndicator extends PanelMenu.Button {
// Create label for task display // Create label for task display
this._label = new St.Label({ this._label = new St.Label({
text: 'loading...', text: 'detecting...',
y_align: Clutter.ActorAlign.CENTER, y_align: Clutter.ActorAlign.CENTER,
style_class: 'deskmeter-task-label' style_class: 'deskmeter-task-label'
}); });
@@ -26,6 +28,7 @@ class TaskIndicator extends PanelMenu.Button {
this._debounceTimeout = null; this._debounceTimeout = null;
this._workspaceManager = global.workspace_manager; this._workspaceManager = global.workspace_manager;
this._apiUrl = null;
// Connect to workspace switch signal // Connect to workspace switch signal
this._workspaceSwitchedId = this._workspaceManager.connect( this._workspaceSwitchedId = this._workspaceManager.connect(
@@ -33,8 +36,46 @@ class TaskIndicator extends PanelMenu.Button {
this._onWorkspaceSwitched.bind(this) this._onWorkspaceSwitched.bind(this)
); );
// Initial update // Detect API port, then start updates
this._detectApiPort();
}
_detectApiPort() {
// Try each port in sequence
this._tryNextPort(0);
}
_tryNextPort(index) {
if (index >= DEFAULT_PORTS.length) {
// No ports responded, use default and let it show "offline"
this._apiUrl = `http://localhost:${DEFAULT_PORTS[DEFAULT_PORTS.length - 1]}/api/current_task`;
this._scheduleUpdate(); this._scheduleUpdate();
return;
}
const port = DEFAULT_PORTS[index];
const url = `http://localhost:${port}/api/current_task`;
try {
let file = Gio.File.new_for_uri(url);
file.load_contents_async(null, (source, result) => {
try {
let [success, contents] = source.load_contents_finish(result);
if (success) {
// Port responded, use it
this._apiUrl = url;
this._scheduleUpdate();
return;
}
} catch (e) {
// This port failed, try next
this._tryNextPort(index + 1);
}
});
} catch (e) {
// This port failed, try next
this._tryNextPort(index + 1);
}
} }
_onWorkspaceSwitched() { _onWorkspaceSwitched() {
@@ -58,9 +99,14 @@ class TaskIndicator extends PanelMenu.Button {
} }
_updateTask() { _updateTask() {
if (!this._apiUrl) {
this._label.set_text('detecting...');
return;
}
try { try {
// Create HTTP request // Create HTTP request
let file = Gio.File.new_for_uri(DESKMETER_API_URL); let file = Gio.File.new_for_uri(this._apiUrl);
file.load_contents_async(null, (source, result) => { file.load_contents_async(null, (source, result) => {
try { try {
let [success, contents] = source.load_contents_finish(result); let [success, contents] = source.load_contents_finish(result);
@@ -95,6 +141,7 @@ class TaskIndicator extends PanelMenu.Button {
} }
destroy() { destroy() {
try {
if (this._debounceTimeout) { if (this._debounceTimeout) {
GLib.source_remove(this._debounceTimeout); GLib.source_remove(this._debounceTimeout);
this._debounceTimeout = null; this._debounceTimeout = null;
@@ -106,6 +153,10 @@ class TaskIndicator extends PanelMenu.Button {
} }
super.destroy(); super.destroy();
} catch (e) {
// Log error but don't crash GNOME Shell
logError(e, 'Failed to destroy TaskIndicator');
}
} }
}); });
@@ -115,17 +166,38 @@ export default class Extension {
} }
enable() { enable() {
try {
this._indicator = new TaskIndicator(); this._indicator = new TaskIndicator();
// Add to panel - position after workspace indicator // Add to panel - position after workspace indicator
// Panel boxes: left, center, right // Panel boxes: left, center, right
// We'll add it to the left panel, after other items // We'll add it to the left panel, after other items
Main.panel.addToStatusArea('deskmeter-task-indicator', this._indicator, 1, 'left'); Main.panel.addToStatusArea('deskmeter-task-indicator', this._indicator, 1, 'left');
} } catch (e) {
// Log error but don't crash GNOME Shell
logError(e, 'Failed to enable Deskmeter extension');
disable() { // Clean up if partially initialized
if (this._indicator) { if (this._indicator) {
try {
this._indicator.destroy(); this._indicator.destroy();
} catch (destroyError) {
logError(destroyError, 'Failed to cleanup indicator');
}
this._indicator = null;
}
}
}
disable() {
try {
if (this._indicator) {
this._indicator.destroy();
this._indicator = null;
}
} catch (e) {
// Log error but don't crash GNOME Shell
logError(e, 'Failed to disable Deskmeter extension');
this._indicator = null; this._indicator = null;
} }
} }

View File

@@ -10,7 +10,9 @@
"44", "44",
"45", "45",
"46", "46",
"47" "47",
"48",
"49"
], ],
"url": "", "url": "",
"version": 1 "version": 1

22
run_task_window.sh Normal file
View File

@@ -0,0 +1,22 @@
#!/bin/bash
# Launcher for Deskmeter Task Window with always-on-top and sticky properties
# Start the task window in background
python3 task_window.py &
TASK_PID=$!
# Wait for window to appear
sleep 2
# Find the window and set properties
# Make it always on top and visible on all workspaces (sticky)
wmctrl -r "Deskmeter Task" -b add,above,sticky
echo "Task window started (PID: $TASK_PID)"
echo "Window set to: always-on-top + visible on all workspaces"
echo ""
echo "To close: kill $TASK_PID"
echo "Or just close the window normally"
# Keep script running to show PID
wait $TASK_PID

167
task_window.py Normal file
View File

@@ -0,0 +1,167 @@
#!/usr/bin/env python3
"""
Deskmeter Task Window - Regular Mode
Shows current task in an always-on-top window visible on all workspaces
"""
import gi
gi.require_version('Gtk', '4.0')
from gi.repository import Gtk, GLib
import urllib.request
import json
import sys
import os
import subprocess
# Try ports in order: env var, command line arg, or try common ports
DEFAULT_PORTS = [10001, 10000] # worktree first, then default
UPDATE_INTERVAL = 500 # milliseconds - fast updates to catch workspace changes
WORKSPACE_CHECK_INTERVAL = 200 # milliseconds - check for workspace changes
# Global API URL (will be set after port detection)
DESKMETER_API_URL = None
class TaskWindow(Gtk.ApplicationWindow):
def __init__(self, app, api_url):
super().__init__(application=app, title="Deskmeter Task")
self.api_url = api_url
# Set window properties
self.set_default_size(400, 60)
# Remove window decorations (no title bar, close button, etc.)
self.set_decorated(False)
# Create label for task display
self.label = Gtk.Label(label="Loading...")
self.label.set_markup('<span font_desc="14">Loading...</span>')
self.label.set_margin_top(20)
self.label.set_margin_bottom(20)
self.label.set_margin_start(20)
self.label.set_margin_end(20)
# Set label to allow selection (useful for copying)
self.label.set_selectable(True)
# Create box container
box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
box.append(self.label)
self.set_child(box)
# Track current workspace for change detection
self.current_workspace = self._get_current_workspace()
self.last_task = None
# Start periodic updates
GLib.timeout_add(UPDATE_INTERVAL, self.update_task)
# Monitor workspace changes more frequently
GLib.timeout_add(WORKSPACE_CHECK_INTERVAL, self.check_workspace_change)
# Initial update
self.update_task()
def _get_current_workspace(self):
"""Get current workspace number using wmctrl"""
try:
result = subprocess.run(['wmctrl', '-d'], capture_output=True, text=True, timeout=1)
for line in result.stdout.splitlines():
if '*' in line: # Current workspace marked with *
return line.split()[0]
except:
pass
return None
def check_workspace_change(self):
"""Check if workspace changed and trigger immediate update"""
new_workspace = self._get_current_workspace()
if new_workspace != self.current_workspace and new_workspace is not None:
self.current_workspace = new_workspace
# Workspace changed, update immediately
GLib.timeout_add(2200, self.update_task) # Wait 2.2s for dmcore to update
return True
def update_task(self):
"""Fetch current task from API and update label"""
try:
with urllib.request.urlopen(self.api_url, timeout=2) as response:
data = json.loads(response.read().decode('utf-8'))
task_path = data.get('task_path', 'no task')
# Only update label if task changed (reduces flicker)
if task_path != self.last_task:
self.last_task = task_path
# Update label with markup for better visibility
self.label.set_markup(f'<span font_desc="14" weight="bold">{task_path}</span>')
except urllib.error.URLError as e:
self.label.set_markup('<span font_desc="14" foreground="red">offline - dmweb not running</span>')
self.last_task = None
except json.JSONDecodeError as e:
self.label.set_markup('<span font_desc="14" foreground="orange">error - invalid API response</span>')
self.last_task = None
except Exception as e:
self.label.set_markup(f'<span font_desc="14" foreground="red">error: {str(e)}</span>')
self.last_task = None
# Return True to keep the timer running
return True
class TaskApp(Gtk.Application):
def __init__(self, api_url):
super().__init__(application_id='local.deskmeter.task-window')
self.api_url = api_url
def do_activate(self):
window = TaskWindow(self, self.api_url)
window.present()
def detect_api_port():
"""Try to find which port the dmweb API is running on"""
# Check environment variable first
env_port = os.environ.get('DESKMETER_PORT')
if env_port:
url = f'http://localhost:{env_port}/api/current_task'
print(f"Using port from DESKMETER_PORT env var: {env_port}")
return url
# Try common ports
for port in DEFAULT_PORTS:
url = f'http://localhost:{port}/api/current_task'
try:
with urllib.request.urlopen(url, timeout=1) as response:
# If we get here, the port is responding
print(f"Found dmweb API on port {port}")
return url
except:
continue
# Fallback to default
print(f"Could not detect dmweb API, using default port {DEFAULT_PORTS[-1]}")
return f'http://localhost:{DEFAULT_PORTS[-1]}/api/current_task'
def main():
# Check for port argument
if len(sys.argv) > 1 and sys.argv[1].isdigit():
port = sys.argv[1]
api_url = f'http://localhost:{port}/api/current_task'
print(f"Using port from command line: {port}")
else:
api_url = detect_api_port()
print(f"API URL: {api_url}")
app = TaskApp(api_url)
return app.run([])
if __name__ == '__main__':
main()