ske087/digiserver-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit: DigiServer v2 with Blueprint Architecture

Browse Source 
Features implemented:
- Application factory pattern with environment-based config
- 7 modular blueprints (main, auth, admin, players, groups, content, api)
- Flask-Caching with Redis support for production
- Flask-Login authentication with bcrypt password hashing
- API endpoints with rate limiting and Bearer token auth
- Comprehensive error handling and logging
- CLI commands (init-db, create-admin, seed-db)

Blueprint Structure:
- main: Dashboard with caching, health check endpoint
- auth: Login, register, logout, password change
- admin: User management, system settings, theme, logo upload
- players: Full CRUD, fullscreen view, bulk operations, playlist management
- groups: Group management, player assignments, content management
- content: Upload with progress tracking, file management, preview/download
- api: RESTful endpoints with authentication, rate limiting, player feedback

Performance Optimizations:
- Dashboard caching (60s timeout)
- Playlist caching (5min timeout)
- Redis caching for production
- Memoized functions for expensive operations
- Cache clearing on data changes

Security Features:
- Bcrypt password hashing
- Flask-Login session management
- admin_required decorator for authorization
- Player authentication via auth codes
- API Bearer token authentication
- Rate limiting on API endpoints (60 req/min default)
- Input validation and sanitization

Documentation:
- README.md: Full project documentation with quick start
- PROGRESS.md: Detailed progress tracking and roadmap
- BLUEPRINT_GUIDE.md: Quick reference for blueprint architecture

Pending work:
- Models migration from v1 with database indexes
- Utils migration from v1 with type hints
- Templates migration with updated route references
- Docker multi-stage build configuration
- Unit tests for all blueprints

Ready for models and utils migration from digiserver v1
This commit is contained in:
ske087
2025-11-12 10:00:30 +02:00
commit 244b44f5e0
17 changed files with 3420 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

282
PROGRESS.md Normal file
View File

@@ -0,0 +1,282 @@
# Digiserver v2 - Blueprint Architecture Implementation Progress
## ✅ Completed Components
### Core Infrastructure (100%)
- ✅ **config.py** - Environment-based configuration (Development, Production, Testing)
- ✅ **extensions.py** - Centralized Flask extension initialization
- ✅ **app.py** - Application factory with blueprint registration
- ✅ **.env.example** - Environment variable template
- ✅ **.gitignore** - Git ignore patterns
- ✅ **requirements.txt** - Python dependencies with Flask 3.1.0, Flask-Caching, Redis
### Blueprints (100%)
All 6 blueprints completed with full functionality:
#### 1. **main.py** ✅
- Dashboard with caching (60s timeout)
- Health check endpoint with database and disk validation
- Server statistics display
#### 2. **auth.py** ✅
- Login with bcrypt password verification, remember me, next page redirect
- Logout with logging
- Register with validation (min 6 chars, username uniqueness check)
- Change password with current password verification
- Input sanitization and error handling
#### 3. **admin.py** ✅
- Admin panel with system overview (users, players, groups, content, storage)
- User management (create, change role, delete)
- Theme settings (light/dark mode)
- Logo upload functionality
- System logs management (view, clear)
- System information API endpoint (CPU, memory, disk)
- `admin_required` decorator for authorization
#### 4. **players.py** ✅
- Players list with status information
- Add player with auth code generation
- Edit player (name, location, group assignment)
- Delete player with cascade feedback deletion
- Regenerate auth code
- Player page with playlist and feedback
- Player fullscreen view with auth code verification
- Playlist caching (5 min timeout)
- Content reordering
- Bulk operations (delete players, assign to group)
#### 5. **groups.py** ✅
- Groups list with statistics
- Create group with content assignment
- Edit group (name, description, content)
- Delete group with player unassignment
- Manage group page (player status cards, content management)
- Group fullscreen view for monitoring
- Add/remove players from group
- Add/remove content from group
- Content reordering within group
- Group statistics API endpoint
#### 6. **content.py** ✅
- Content list with group information
- Upload content with progress tracking
- File type detection (image, video, PDF, presentation)
- Edit content metadata (duration, description)
- Delete content with file removal
- Bulk delete content
- Upload progress API endpoint
- Content preview/download
- Content statistics (total, by type, storage)
- Duplicate filename checker
- Content groups information API
#### 7. **api.py** ✅
- Health check endpoint
- Get player playlist (with auth and rate limiting)
- Player feedback submission
- Player status endpoint
- Upload progress tracking
- System information API
- List groups API
- List content API
- Server logs API with filtering
- Rate limiting decorator (60 req/min default)
- Player authentication via Bearer token
- API error handlers (404, 405, 500)
### Documentation (100%)
- ✅ **README.md** - Comprehensive project documentation
- ✅ Project structure diagram
- ✅ Quick start guide (development and Docker)
- ✅ Features list and optimization summary
---
## 📋 Pending Tasks
### Models (Priority: Critical)
Need to copy and adapt from v1 with improvements:
1. **User Model** - Add indexes on username
2. **Player Model** - Add indexes on auth_code, group_id, last_seen
3. **Group Model** - Add indexes on name
4. **Content Model** - Add indexes on content_type, position, uploaded_at
5. **ServerLog Model** - Add indexes on level, timestamp
6. **PlayerFeedback Model** - Add indexes on player_id, timestamp
7. **Association Tables** - group_content for many-to-many relationship
### Utils (Priority: Critical)
Need to copy and adapt from v1 with type hints:
1. **logger.py** - Logging utility with type hints
2. **uploads.py** - File upload utilities with progress tracking
3. **group_player_management.py** - Group/player management functions
4. **pptx_converter.py** - PowerPoint conversion utility
### Templates (Priority: High)
Need to copy from v1 and update route references:
1. Update all `url_for()` calls to use blueprint naming:
- `url_for('login')` → `url_for('auth.login')`
- `url_for('dashboard')` → `url_for('main.dashboard')`
- `url_for('add_player')` → `url_for('players.add_player')`
- etc.
2. Organize templates into subdirectories:
- `auth/` - login.html, register.html
- `admin/` - admin.html
- `players/` - players_list.html, add_player.html, edit_player.html, player_page.html, player_fullscreen.html
- `groups/` - groups_list.html, create_group.html, edit_group.html, manage_group.html, group_fullscreen.html
- `content/` - content_list.html, upload_content.html, edit_content.html
- `errors/` - 404.html, 403.html, 500.html
- `base.html` - Main layout template
### Docker Configuration (Priority: High)
1. **Dockerfile** - Multi-stage build targeting 800MB
2. **docker-compose.yml** - Services: digiserver, redis, optional worker
3. **nginx.conf** - Reverse proxy configuration
4. **.dockerignore** - Docker ignore patterns
### Testing (Priority: Medium)
1. **tests/conftest.py** - Test fixtures
2. **tests/test_auth.py** - Authentication tests
3. **tests/test_players.py** - Player management tests
4. **tests/test_groups.py** - Group management tests
5. **tests/test_content.py** - Content management tests
6. **tests/test_api.py** - API endpoint tests
### Git Repository (Priority: Medium)
1. Initialize Git repository
2. Create initial commit
3. Push to remote (if desired)
---
## 🎯 Next Steps
### Immediate Actions
1. **Copy models from v1** - Add to `app/models/` with:
- Type hints
- Database indexes
- Proper relationships
- `__repr__` methods
2. **Copy utils from v1** - Add to `app/utils/` with:
- Type hints
- Improved error handling
- Documentation
3. **Create model init file** - `app/models/__init__.py` to export all models
### After Models/Utils
4. **Copy templates from v1** - Update route references to blueprint naming
5. **Create Docker configuration** - Multi-stage build with optimization
6. **Test application** - Ensure all routes work correctly
7. **Initialize Git** - Create repository and initial commit
---
## 📊 Progress Summary
| Component | Status | Progress |
|-----------|--------|----------|
| Core Infrastructure | ✅ Complete | 100% |
| Blueprints (6) | ✅ Complete | 100% |
| Documentation | ✅ Complete | 100% |
| Models | ⏳ Pending | 0% |
| Utils | ⏳ Pending | 0% |
| Templates | ⏳ Pending | 0% |
| Docker | ⏳ Pending | 0% |
| Testing | ⏳ Pending | 0% |
| Git | ⏳ Pending | 0% |
**Overall Progress: ~50%**
---
## 🔧 Key Features Implemented
### Blueprint Architecture
- ✅ Modular route organization (7 blueprints)
- ✅ URL prefixes for namespace separation
- ✅ Blueprint-specific error handlers in API
- ✅ Shared extension initialization
### Performance Optimizations
- ✅ Flask-Caching with Redis support
- ✅ Playlist caching (5 min timeout)
- ✅ Dashboard caching (60s timeout)
- ✅ Memoized functions with cache.memoize()
- ✅ Cache clearing on data changes
### Security Features
- ✅ Bcrypt password hashing
- ✅ Flask-Login session management
- ✅ `admin_required` decorator
- ✅ Player authentication via auth codes
- ✅ API Bearer token authentication
- ✅ Rate limiting on API endpoints
- ✅ Input validation and sanitization
- ✅ CSRF protection (Flask-WTF ready)
### API Features
- ✅ RESTful endpoints for players, groups, content
- ✅ Player playlist API with caching
- ✅ Player feedback submission
- ✅ Upload progress tracking
- ✅ System information API
- ✅ Rate limiting (60 req/min default)
- ✅ JSON error responses
- ✅ Health check endpoint
### Development Features
- ✅ Application factory pattern
- ✅ Environment-based configuration
- ✅ CLI commands (init-db, create-admin, seed-db)
- ✅ Comprehensive logging
- ✅ Context processors for templates
- ✅ Error handlers for common HTTP errors
---
## 📝 Notes
### Architecture Decisions
- **Blueprint organization**: Logical separation by functionality
- **Caching strategy**: Redis for production, SimpleCache for development
- **Authentication**: Flask-Login for web, Bearer tokens for API
- **Rate limiting**: In-memory for now, should use Redis in production
- **File uploads**: Direct save with progress tracking, can add Celery for async processing
### Optimization Opportunities
- Add Celery for async video processing
- Implement WebSocket for real-time player updates
- Add comprehensive database migrations
- Implement API versioning (v1, v2)
- Add comprehensive test coverage
- Add Sentry for error tracking
### Migration from v1
When copying from v1, remember to:
- Update all route references to blueprint naming
- Add type hints to all functions
- Add database indexes for performance
- Update imports to match new structure
- Update static file paths in templates
- Test all functionality thoroughly
---
## 🚀 Ready for Next Phase
The blueprint architecture is now **fully implemented** with all 6 blueprints:
- ✅ main (dashboard, health)
- ✅ auth (login, register, logout)
- ✅ admin (user management, system settings)
- ✅ players (CRUD, fullscreen, bulk ops)
- ✅ groups (CRUD, manage, fullscreen)
- ✅ content (upload, manage, API)
- ✅ api (REST endpoints, authentication, rate limiting)
**Ready to proceed with models and utils migration!**