Flarum Auto Lock Extension

🔒 Automatically lock discussions when they reach a specified number of posts.

Features

• ✅ Automatic Locking: Discussions are automatically locked when reaching the configured post count
• ⚙️ Configurable Threshold: Set custom post count threshold in admin panel (default: 100)
• 🎛️ Enable/Disable Toggle: Easy on/off switch in admin settings
• 🌍 Multi-language Support: English and Simplified Chinese included
• 🚀 Event-Driven: Uses Flarum's native event system for optimal performance
• 🔧 Zero Configuration: Works out of the box with sensible defaults
• 📊 Detailed Logging: Comprehensive logs for debugging and monitoring

Installation

Install via Composer:

composer require wszdb/flarum-autolock

Enable the extension:

php flarum extension:enable wszdb-autolock

Clear cache:

php flarum cache:clear

Configuration

1. Navigate to Admin Panel → Extensions
2. Find Auto Lock extension
3. Click Settings button
4. Configure options:
   • Enable Auto Lock: Toggle to enable/disable the feature
   • Post Count Threshold: Set the number of posts after which discussions will be locked (minimum: 1, default: 100)

How It Works

Post Count Calculation

The extension uses the following formula to calculate total posts:

Total Posts = comment_count (replies) + 1 (original post)

Example:
- Original post = Floor 1
- 99 replies = Floor 2-100
- Total = 100 floors

When total >= threshold → Auto lock ✅

Trigger Logic

1. When a new post is published, the extension listens to the Posted event
2. It refreshes the discussion data and calculates total posts
3. If total posts ≥ threshold and discussion is not locked, it locks the discussion
4. All actions are logged for monitoring

Important Notes

• ⚠️ Only affects new posts: Extension does not retroactively lock old discussions
• ⚠️ Event-driven: Locks happen when someone posts, not on a schedule
• ✅ Skips locked discussions: Already locked discussions are ignored

Testing

Quick Test

1. Set threshold to 5 in admin panel
2. Create a new discussion (this is post #1)
3. Add 4 replies (posts #2-5)
4. Discussion should automatically lock after the 5th post

Verify Logs

tail -f /path/to/flarum/storage/logs/flarum-$(date +%Y-%m-%d).log | grep "Auto Lock"

Expected output:

[Auto Lock] Event triggered {"discussion_id":123,"total_posts":5}
[Auto Lock] Threshold check {"threshold":5,"total_posts":5,"will_lock":true}
[Auto Lock] Discussion locked successfully

Troubleshooting

Extension not working

1. Check if enabled

   # In admin panel: Extensions → Auto Lock → Ensure toggle is ON
   

2. Clear cache

   php flarum cache:clear
   rm -rf storage/cache/*
   

3. Restart PHP-FPM

   systemctl restart php8.2-fpm
   

4. Check logs

   tail -100 storage/logs/flarum-$(date +%Y-%m-%d).log | grep "Auto Lock"
   

No logs appearing

• Ensure extension is enabled in admin panel
• Check file exists: vendor/wszdb/flarum-autolock/src/Listener/PostedListener.php
• Verify file permissions on storage/logs/

Post count shows 0 in logs

• Old version: Update to v2.0.2 or later
• Fix: Use comment_count + 1 instead of post_number_index

Old discussions not locking

• Extension only works on new posts
• It does not retroactively lock existing discussions
• To lock old discussions: manually lock them or wait for new replies

Technical Details

PHP Requirements

• PHP 8.2 or higher
• Flarum 1.8.0 or higher

Dependencies

• flarum/core: ^1.8.0
• PSR-3 LoggerInterface for logging

Event Listener

• Listens to: Flarum\Post\Event\Posted
• Uses: Psr\Log\LoggerInterface (not Facade)
• Calculates: $discussion->comment_count + 1

Version History

See CHANGELOG.md for detailed version history.

Latest Version: 2.0.2

• Fixed post count calculation
• Fixed logging issues
• Production ready

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details.

License

This extension is licensed under the MIT License.

Links

• Packagist
• GitHub Repository
• Flarum Community

Developed by wszdb