Vervis/config/models

-- This file is part of Vervis.
--
-- Written in 2016, 2018 by fr33domlover <fr33domlover@riseup.net>.
--
-- ♡ Copying is an act of love. Please copy, reuse and share.
--
-- The author(s) have dedicated all copyright and related and neighboring
-- rights to this software to the public domain worldwide. This software is
-- distributed without any warranty.
--
-- You should have received a copy of the CC0 Public Domain Dedication along
-- with this software. If not, see
-- <http://creativecommons.org/publicdomain/zero/1.0/>.

-------------------------------------------------------------------------------
-- People
-------------------------------------------------------------------------------

Sharer
    ident   ShrIdent
    name    Text     Maybe
    created UTCTime

    UniqueSharer ident

Person
    ident               SharerId
    login               Text
    passphraseHash      ByteString
    email               EmailAddress
    verified            Bool
    verifiedKey         Text
    verifiedKeyCreated  UTCTime
    resetPassKey        Text
    resetPassKeyCreated UTCTime

    UniquePersonIdent ident
    UniquePersonLogin login
    UniquePersonEmail email

SshKey
    ident   KyIdent
    person  PersonId
    algo    ByteString
    content ByteString

    UniqueSshKey person ident

Group
    ident SharerId

    UniqueGroup ident

GroupMember
    person PersonId
    group  GroupId
    role   GroupRole
    joined UTCTime

    UniqueGroupMember person group

RepoRole
    ident  RlIdent
    sharer SharerId
    desc   Text

    UniqueRepoRole sharer ident

RepoRoleInherit
    parent RepoRoleId
    child  RepoRoleId

    UniqueRepoRoleInherit parent child

RepoAccess
    role RepoRoleId
    op   RepoOperation

    UniqueRepoAccess role op

RepoCollab
    repo   RepoId
    person PersonId
    role   RepoRoleId

    UniqueRepoCollab repo person

RepoCollabAnon
    repo RepoId
    role RepoRoleId

    UniqueRepoCollabAnon repo

RepoCollabUser
    repo RepoId
    role RepoRoleId

    UniqueRepoCollabUser repo

ProjectRole
    ident  RlIdent
    sharer SharerId
    desc   Text

    UniqueProjectRole sharer ident

ProjectRoleInherit
    parent ProjectRoleId
    child  ProjectRoleId

    UniqueProjectRoleInherit parent child

ProjectAccess
    role ProjectRoleId
    op   ProjectOperation

    UniqueProjectAccess role op

ProjectCollab
    project ProjectId
    person  PersonId
    role    ProjectRoleId

    UniqueProjectCollab project person

ProjectCollabAnon
    repo ProjectId
    role ProjectRoleId

    UniqueProjectCollabAnon repo

ProjectCollabUser
    repo ProjectId
    role ProjectRoleId

    UniqueProjectCollabUser repo

-------------------------------------------------------------------------------
-- Projects
-------------------------------------------------------------------------------

Project
    ident      PrjIdent
    sharer     SharerId
    name       Text       Maybe
    desc       Text       Maybe
    workflow   WorkflowId
    nextTicket Int
    wiki       RepoId     Maybe

    UniqueProject ident sharer

Repo
    ident      RpIdent
    sharer     SharerId
    vcs        VersionControlSystem
    project    ProjectId            Maybe
    desc       Text                 Maybe
    mainBranch Text

    UniqueRepo ident sharer

Workflow
    sharer SharerId
    ident  WflIdent
    name   Text          Maybe
    desc   Text          Maybe
    scope  WorkflowScope

    UniqueWorkflow sharer ident

WorkflowField
    workflow     WorkflowId
    ident        FldIdent
    name         Text
    desc         Text                Maybe
    type         WorkflowFieldType
    enm          WorkflowFieldEnumId Maybe
    required     Bool
    constant     Bool
    filterNew    Bool
    filterTodo   Bool
    filterClosed Bool

    UniqueWorkflowField workflow ident

WorkflowFieldEnum
    workflow WorkflowId
    ident    EnmIdent
    name     Text
    desc     Text       Maybe

    UniqueWorkflowFieldEnum workflow ident

WorkflowFieldEnumCtor
    enum WorkflowFieldEnumId
    name Text
    desc Text                Maybe

    UniqueWorkflowFieldEnumCtor enum name

TicketParamText
    ticket TicketId
    field  WorkflowFieldId
    value  Text

    UniqueTicketParamText ticket field

TicketParamEnum
    ticket TicketId
    field  WorkflowFieldId
    value  WorkflowFieldEnumCtorId

    UniqueTicketParamEnum ticket field value

Ticket
    project  ProjectId
    number   Int
    created  UTCTime
    creator  PersonId
    title    Text
    desc     Text -- Assume this is Pandoc Markdown
    assignee PersonId     Maybe
    status   TicketStatus
    closed   UTCTime
    closer   PersonId
    discuss  DiscussionId

    UniqueTicket project number

TicketDependency
    parent TicketId
    child  TicketId

    UniqueTicketDependency parent child

TicketClaimRequest
    person  PersonId
    ticket  TicketId
    message Text     -- Assume this is Pandoc Markdown
    created UTCTime

    UniqueTicketClaimRequest person ticket

Discussion
    nextMessage Int

Message
    author  PersonId
    created UTCTime
    content Text               -- Assume this is Pandoc Markdown
    parent  MessageId    Maybe
    root    DiscussionId
    number  Int

    UniqueMessage root number
Move some files around, tweak the generated code a bit 2016-02-14 10:10:21 +01:00			`-- This file is part of Vervis.`
			`--`
Use my new persistent-migration library, to which I moved the related modules 2018-02-26 15:23:02 +01:00			`-- Written in 2016, 2018 by fr33domlover <fr33domlover@riseup.net>.`
Move some files around, tweak the generated code a bit 2016-02-14 10:10:21 +01:00			`--`
			`-- ♡ Copying is an act of love. Please copy, reuse and share.`
			`--`
			`-- The author(s) have dedicated all copyright and related and neighboring`
			`-- rights to this software to the public domain worldwide. This software is`
			`-- distributed without any warranty.`
			`--`
			`-- You should have received a copy of the CC0 Public Domain Dedication along`
			`-- with this software. If not, see`
			`-- <http://creativecommons.org/publicdomain/zero/1.0/>.`

Rename PersonInGroup model to GroupMember 2016-05-24 10:28:57 +02:00			`-------------------------------------------------------------------------------`
			`-- People`
			`-------------------------------------------------------------------------------`

Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00			`Sharer`
New sharer field: Creation time 2016-05-24 10:34:40 +02:00			`ident ShrIdent`
			`name Text Maybe`
Remove the last remaining default= from models file Since defaults are specified in Form code that inserts new entities, they already appear on the application side. So I'm going to try managing them only in the application, and not have defaults in the DB at all (maybe just temporarily when needed for schema migrations). 2016-08-20 19:32:27 +02:00			`created UTCTime`
Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00
Finish route change, it builds now I used this chance to make some name changes, add some utils, tweak some imports, remove more `setTitle`s and so on. I also made person, repo, key and project creation forms verify CI-uniqueness. 2016-05-23 22:46:54 +02:00			`UniqueSharer ident`
Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00
			`Person`
Email tokens expire within 1 day 2018-04-01 05:02:35 +02:00			`ident SharerId`
			`login Text`
			`passphraseHash ByteString`
			`email EmailAddress`
			`verified Bool`
			`verifiedKey Text`
			`verifiedKeyCreated UTCTime`
			`resetPassKey Text`
			`resetPassKeyCreated UTCTime`
Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00
			`UniquePersonIdent ident`
			`UniquePersonLogin login`
Allow login using email address 2018-04-11 13:09:42 +02:00			`UniquePersonEmail email`
Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00
Implement DB-based SSH authentication 2016-03-06 12:58:48 +01:00			`SshKey`
Finish route change, it builds now I used this chance to make some name changes, add some utils, tweak some imports, remove more `setTitle`s and so on. I also made person, repo, key and project creation forms verify CI-uniqueness. 2016-05-23 22:46:54 +02:00			`ident KyIdent`
Implement DB-based SSH authentication 2016-03-06 12:58:48 +01:00			`person PersonId`
			`algo ByteString`
			`content ByteString`

Finish route change, it builds now I used this chance to make some name changes, add some utils, tweak some imports, remove more `setTitle`s and so on. I also made person, repo, key and project creation forms verify CI-uniqueness. 2016-05-23 22:46:54 +02:00			`UniqueSshKey person ident`
Implement DB-based SSH authentication 2016-03-06 12:58:48 +01:00
Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00			`Group`
			`ident SharerId`

Rename PersonInGroup model to GroupMember 2016-05-24 10:28:57 +02:00			`UniqueGroup ident`

			`GroupMember`
			`person PersonId`
			`group GroupId`
Add group roles and make a group's creator its admin 2016-05-25 17:52:15 +02:00			`role GroupRole`
Enable adding group members 2016-05-26 18:25:23 +02:00			`joined UTCTime`
Rename PersonInGroup model to GroupMember 2016-05-24 10:28:57 +02:00
			`UniqueGroupMember person group`

Make all role-related code repo-specific 2016-06-01 09:35:22 +02:00			`RepoRole`
Initial minimal limited per-repo RBAC system 2016-05-29 15:17:55 +02:00			`ident RlIdent`
Roles now under by sharers, i.e. now groups too 2016-06-06 19:29:54 +02:00			`sharer SharerId`
Initial minimal limited per-repo RBAC system 2016-05-29 15:17:55 +02:00			`desc Text`

Roles now under by sharers, i.e. now groups too 2016-06-06 19:29:54 +02:00			`UniqueRepoRole sharer ident`
Initial minimal limited per-repo RBAC system 2016-05-29 15:17:55 +02:00
Project role inheritance and graph queries with some raw SQL 2016-06-17 22:17:39 +02:00			`RepoRoleInherit`
			`parent RepoRoleId`
			`child RepoRoleId`

			`UniqueRepoRoleInherit parent child`

Make all role-related code repo-specific 2016-06-01 09:35:22 +02:00			`RepoAccess`
			`role RepoRoleId`
			`op RepoOperation`
Initial minimal limited per-repo RBAC system 2016-05-29 15:17:55 +02:00
Make all role-related code repo-specific 2016-06-01 09:35:22 +02:00			`UniqueRepoAccess role op`
Initial minimal limited per-repo RBAC system 2016-05-29 15:17:55 +02:00
Make all role-related code repo-specific 2016-06-01 09:35:22 +02:00			`RepoCollab`
Initial minimal limited per-repo RBAC system 2016-05-29 15:17:55 +02:00			`repo RepoId`
			`person PersonId`
Make all role-related code repo-specific 2016-06-01 09:35:22 +02:00			`role RepoRoleId`
Initial minimal limited per-repo RBAC system 2016-05-29 15:17:55 +02:00
Make all role-related code repo-specific 2016-06-01 09:35:22 +02:00			`UniqueRepoCollab repo person`
Initial minimal limited per-repo RBAC system 2016-05-29 15:17:55 +02:00
Specify default role for repo and project visitors 2016-07-03 09:52:11 +02:00			`RepoCollabAnon`
			`repo RepoId`
			`role RepoRoleId`

			`UniqueRepoCollabAnon repo`

			`RepoCollabUser`
			`repo RepoId`
			`role RepoRoleId`

			`UniqueRepoCollabUser repo`

Add project roles, basically a copy of the repo role code 2016-06-01 10:52:14 +02:00			`ProjectRole`
			`ident RlIdent`
Roles now under by sharers, i.e. now groups too 2016-06-06 19:29:54 +02:00			`sharer SharerId`
Add project roles, basically a copy of the repo role code 2016-06-01 10:52:14 +02:00			`desc Text`

Roles now under by sharers, i.e. now groups too 2016-06-06 19:29:54 +02:00			`UniqueProjectRole sharer ident`
Add project roles, basically a copy of the repo role code 2016-06-01 10:52:14 +02:00
Build role graph 2016-06-21 09:35:19 +02:00			`ProjectRoleInherit`
			`parent ProjectRoleId`
			`child ProjectRoleId`

			`UniqueProjectRoleInherit parent child`

Add project roles, basically a copy of the repo role code 2016-06-01 10:52:14 +02:00			`ProjectAccess`
			`role ProjectRoleId`
			`op ProjectOperation`

			`UniqueProjectAccess role op`

			`ProjectCollab`
			`project ProjectId`
			`person PersonId`
			`role ProjectRoleId`

			`UniqueProjectCollab project person`

Specify default role for repo and project visitors 2016-07-03 09:52:11 +02:00			`ProjectCollabAnon`
			`repo ProjectId`
			`role ProjectRoleId`

			`UniqueProjectCollabAnon repo`

			`ProjectCollabUser`
			`repo ProjectId`
			`role ProjectRoleId`

			`UniqueProjectCollabUser repo`

Rename PersonInGroup model to GroupMember 2016-05-24 10:28:57 +02:00			`-------------------------------------------------------------------------------`
			`-- Projects`
			`-------------------------------------------------------------------------------`
Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00
			`Project`
Finish route change, it builds now I used this chance to make some name changes, add some utils, tweak some imports, remove more `setTitle`s and so on. I also made person, repo, key and project creation forms verify CI-uniqueness. 2016-05-23 22:46:54 +02:00			`ident PrjIdent`
Add Ticket to persistent model 2016-04-30 22:40:33 +02:00			`sharer SharerId`
Projects must specify a ticket workflow 2016-08-08 21:05:22 +02:00			`name Text Maybe`
			`desc Text Maybe`
			`workflow WorkflowId`
Remove some default column values from model, leave that to Haskell 2016-08-08 20:35:01 +02:00			`nextTicket Int`
Projects must specify a ticket workflow 2016-08-08 21:05:22 +02:00			`wiki RepoId Maybe`
Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00
			`UniqueProject ident sharer`

			`Repo`
Finish route change, it builds now I used this chance to make some name changes, add some utils, tweak some imports, remove more `setTitle`s and so on. I also made person, repo, key and project creation forms verify CI-uniqueness. 2016-05-23 22:46:54 +02:00			`ident RpIdent`
Repos right under users, not under projects 2016-04-12 19:37:31 +02:00			`sharer SharerId`
Remove some default column values from model, leave that to Haskell 2016-08-08 20:35:01 +02:00			`vcs VersionControlSystem`
Repos specify their VCS (i.e. Git or Darcs) in the DB 2016-05-03 01:51:53 +02:00			`project ProjectId Maybe`
			`desc Text Maybe`
Remove some default column values from model, leave that to Haskell 2016-08-08 20:35:01 +02:00			`mainBranch Text`
Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00
Repos right under users, not under projects 2016-04-12 19:37:31 +02:00			`UniqueRepo ident sharer`
Make initial homepage with table and simple login 2016-02-16 12:41:13 +01:00
Per-sharer ticket workflows A workflow is a new entity in Vervis. It defines the workflow of a projects' ticket system. That includes the possible ticket states, custom ticket fields, various filters and so on. All ticket system customization is currently planned to be managed using workflows. Currently workflows are private and per sharer, but the plan is to support public workflows that can be shared and cloned. 2016-08-08 13:05:19 +02:00			`Workflow`
			`sharer SharerId`
			`ident WflIdent`
			`name Text Maybe`
			`desc Text Maybe`
Workflow scope field, minimal support 2016-09-01 19:40:02 +02:00			`scope WorkflowScope`
Per-sharer ticket workflows A workflow is a new entity in Vervis. It defines the workflow of a projects' ticket system. That includes the possible ticket states, custom ticket fields, various filters and so on. All ticket system customization is currently planned to be managed using workflows. Currently workflows are private and per sharer, but the plan is to support public workflows that can be shared and cloned. 2016-08-08 13:05:19 +02:00
			`UniqueWorkflow sharer ident`

Per-workflow custom ticket fields 2016-08-08 16:01:06 +02:00			`WorkflowField`
Custom ticket field relevance filter by ticket status 2016-08-11 11:27:30 +02:00			`workflow WorkflowId`
			`ident FldIdent`
			`name Text`
			`desc Text Maybe`
			`type WorkflowFieldType`
			`enm WorkflowFieldEnumId Maybe`
			`required Bool`
			`constant Bool`
			`filterNew Bool`
			`filterTodo Bool`
			`filterClosed Bool`
Per-workflow custom ticket fields 2016-08-08 16:01:06 +02:00
			`UniqueWorkflowField workflow ident`

Per-workflow custom ticket field enum types 2016-08-08 16:48:38 +02:00			`WorkflowFieldEnum`
			`workflow WorkflowId`
			`ident EnmIdent`
			`name Text`
			`desc Text Maybe`

			`UniqueWorkflowFieldEnum workflow ident`

Field enums aren't useful if you can't define values 2016-08-08 19:05:09 +02:00			`WorkflowFieldEnumCtor`
			`enum WorkflowFieldEnumId`
			`name Text`
			`desc Text Maybe`

			`UniqueWorkflowFieldEnumCtor enum name`

Display custom ticket field values in ticket page 2016-08-08 22:51:58 +02:00			`TicketParamText`
			`ticket TicketId`
			`field WorkflowFieldId`
			`value Text`

			`UniqueTicketParamText ticket field`

Display custom enum fields in ticket page 2016-08-09 13:36:14 +02:00			`TicketParamEnum`
			`ticket TicketId`
			`field WorkflowFieldId`
			`value WorkflowFieldEnumCtorId`

			`UniqueTicketParamEnum ticket field value`

Add Ticket to persistent model 2016-04-30 22:40:33 +02:00			`Ticket`
Ticket assignee field 2016-06-01 18:20:19 +02:00			`project ProjectId`
			`number Int`
			`created UTCTime`
			`creator PersonId`
			`title Text`
			`desc Text -- Assume this is Pandoc Markdown`
			`assignee PersonId Maybe`
Turn boolean ticketDone into TicketStatus enum 2016-08-11 02:44:11 +02:00			`status TicketStatus`
Ticket assignee field 2016-06-01 18:20:19 +02:00			`closed UTCTime`
			`closer PersonId`
			`discuss DiscussionId`
Add Ticket to persistent model 2016-04-30 22:40:33 +02:00
			`UniqueTicket project number`
Compressed inventory parser and DarcsRev TH utils 2016-05-17 22:34:22 +02:00
Ticket dependencies in DB and per-ticket list of children 2016-06-07 22:16:15 +02:00			`TicketDependency`
			`parent TicketId`
			`child TicketId`

			`UniqueTicketDependency parent child`

Ticket claim requests in DB and personal list view of them 2016-06-07 12:01:57 +02:00			`TicketClaimRequest`
			`person PersonId`
			`ticket TicketId`
Per-ticket list of claim requests with full info 2016-06-07 18:31:55 +02:00			`message Text -- Assume this is Pandoc Markdown`
Ticket claim requests in DB and personal list view of them 2016-06-07 12:01:57 +02:00			`created UTCTime`

			`UniqueTicketClaimRequest person ticket`

Compressed inventory parser and DarcsRev TH utils 2016-05-17 22:34:22 +02:00			`Discussion`
Ticket discussion and message routes 2016-05-19 18:58:23 +02:00			`nextMessage Int`
Compressed inventory parser and DarcsRev TH utils 2016-05-17 22:34:22 +02:00
			`Message`
			`author PersonId`
			`created UTCTime`
			`content Text -- Assume this is Pandoc Markdown`
			`parent MessageId Maybe`
			`root DiscussionId`
Ticket discussion and message routes 2016-05-19 18:58:23 +02:00			`number Int`

			`UniqueMessage root number`