benkasminbullock / bagzulla

INTRODUCTION

This is a bug tracker. It is designed to be used on a local server. It provides a replacement for some of the functions of Bugzilla. It uses SQLite as a backing store for the bugs.

Design goals

This bug tracker was designed for me to use on a home web server. It was designed to be very easy to enter the data without a lot of restrictions. For example you can enter a bug without any description, or even without a notification of what project the bug belongs to, and then fix that up later. I was running bugzilla via the CGI interface at the time, and got very frustrated with having to enter lots of extraneous data and also with the big delays of Bugzilla. The name is a parody of "bugzilla".

INSTALLATION

At the moment installation is not very smooth.

You can build the application with the command make. You then need to create and populate a database using the schema with

scripts/init.pl

This requires you to have Perl and the modules DBI, DBD::sqlite, and JSON::Parse. It renames any old database file called bagzulla.db with the suffix .backup, then it creates the database file again from the schema in schema.txt by copying some users from users.json in the top directory. You'll need to add a name and password for whatever user name you want to use, or you can add those directly to the database using the sqlite3 command.

STARTING THE SERVER

You can run the server like this:

./bagzulla &

This will connect to the database in its running directory, so you need to have read and write permissions for bagzulla.db in that directory. You can specify another database using the option --database.

If you're using a proxy, you can run it something like this:

nohup ./bagzulla --url http://localhost/xyz --port 1919 > log 2>&1 &

There is an example script in run.sh in the top directory.

Changing the database

You can specify another database using the option --database.

./bagzulla --database super.db

This will have to be an sqlite3 database file.

Displaying directories

If you want to make the directories work, you can specify a directory display URL using the command-line option --display. See run.sh for an example of how this works for me locally.

STOPPING THE SERVER

The server can be stopped from the interface using the control at the top, or by a command of the form http://localhost/bagzulla?stop=1. There is a simple script stop.pl in the top directory which does this using the Perl module LWP::UserAgent.

COPYRIGHT AND LICENCE

This project is copyright (c) 2023 Ben Bullock.

It is licenced under the GNU Affero General Public Licence.

bagzulla's Issues

Indent SQL correctly

The SQL is not indented correctly:

bagzulla/schema.txt

Line 2 in 1063a7e

bug_id INTEGER PRIMARY KEY,

Check the return value of system when creating the database using the batch option

bagzulla/scripts/init.pl

Line 15 in 1063a7e

system ("sqlite3 -batch $file < schema.txt");

Some kind of configuration file system

Have a configuration file which can read in settings.

Update README.md for the new init.pl

• Remove the statement about sqlite3
• Add a note that it overwrites the file

Remove traditional C comments

bagzulla/bagzulla.go

Line 131 in 1063a7e

/* This type contains information about related bugs, such as the bug

These fail on go doc.

Disable the directory display if no option is given

If the user does not specify what program to display files with in the browser using the --display option, disable the directory display for the project.

Put the login sessions into the database

Alter the schema to put the logins into the database. Use SearchCookie in database.go.

Change to // comments in auth.go

These comments should all be // style, especially capital-letter functions.

bagzulla/auth.go

Line 103 in 1063a7e

/* This is called directly by /logout/, so it is not from a form, so

Do something about this commented-out code in database.go

Either make a note why this is commented out or remove it:

https://github.com/benkasminbullock/bagzulla/blob/master/database.go#L492-L520

Replace errors.New(fmt.Sprintf( with fmt.Errorf

Use https://pkg.go.dev/errors#example-New-Errorf instead of this construction:

bagzulla/bagzulla.go

Line 116 in 1063a7e

return -1, errors.New(fmt.Sprintf("Unknown priority %s", priorityString))

Add user interface in controls

Allow a user with correct permissions to add a user.

README.md is incorrect

It deletes any old database file called bagzulla.db, then it creates the database file again from the schema in schema.txt by copying some users from users.json in the top directory

is incorrect, it backs up the old database rather than deleting it.

Convert single quotes to double quotes in the templates

Most people use double quotes so change them over with a script.

Remove commented-out old code

bagzulla/stop.pl

Line 9 in 1063a7e

#use BKB::Stuff 'kill_match';

This is old, defunct code which is of no use to anyone else except me and is already commented out. It should be completely removed.

Indent init.pl

Add indentation and a comment on what the script does here:

https://github.com/benkasminbullock/bagzulla/blob/master/scripts/init.pl

Add full undoability

In theory all the actions should be undoable. At the moment this is not implemented.

This example is wrong since "open" is not a priority

This should read something like "high" rather than "open".

bagzulla/bagzulla.go

Line 109 in 1063a7e

// Convert a string like "open" to a priority number.