README
¶
Besides the test files, the important stuff here is:
hub.gohub.pf
hub.pf is the Pipefish service that the user talks to when they talk to the hub. hub.go actually inmplements it.
Much of the logic has to be in hub.go, with hub.pf a thin skin over the top, because there are lots of things that can only be done from Go and not from Pipefish, e.g. compiling and running Pipefish services. A few things would be better off in hub.pf but are in hub.go for historical reasons.
The way it works is that the hub.pf file has a type Hub wrapping io.Writer, and a variable initialized as HUB Hub? = NULL. On creation of the hub service, we inject an io.Writer into the variable, where the Write method tells the hub.pf to do the thing in question.
(The reason we do it this way rather than injecting the Go *hub.Hub object itself is that this requires the production of an .so file which takes over a minute to compile and is larger than the main executable.)
Documentation
¶
Index ¶
- Constants
- Variables
- func AddAdmin(db *sql.DB, username, firstName, lastName, email, password string) error
- func AddUser(db *sql.DB, username, firstName, lastName, email, password string) error
- func AddUserToGroup(db *sql.DB, username, groupName string, owner bool) error
- func ChangePassword(db *sql.DB, username, newPassword string) error
- func CopyFile(srcFile, dstFile string) error
- func CreateGroup(db *sql.DB, groupName string) error
- func Cyan(s string) string
- func DropTables(db *sql.DB)
- func GetGroupsOfService(db *sql.DB, serviceName string) (string, error)
- func GetGroupsOfUser(db *sql.DB, username string, ownGroups bool) (string, error)
- func GetServicesOfGroup(db *sql.DB, groupName string) (string, error)
- func GetServicesOfUser(db *sql.DB, username string, ownServices bool) (string, error)
- func GetUsersOfGroup(db *sql.DB, groupName string) (string, error)
- func GetUsersOfService(db *sql.DB, serviceName string) (string, error)
- func GetWiki()
- func Green(s string) string
- func IsUserAdmin(db *sql.DB, username string) (bool, error)
- func IsUserGroupOwner(db *sql.DB, username, groupName string) error
- func IsUserInGroup(db *sql.DB, username, groupName string) (bool, error)
- func LetGroupUseService(db *sql.DB, groupName, serviceName string) error
- func MakePassword() string
- func ReadChar() rune
- func Red(s string) string
- func ServiceDo(serviceToUse *pf.Service, line string) pf.Value
- func SetOwnership(db *sql.DB, username, groupName string, owner bool) error
- func StartServiceFromCli()
- func UnAddUserToGroup(db *sql.DB, username, groupName string) error
- func UnLetGroupUseService(db *sql.DB, groupName, serviceName string) error
- func UnRegisterUser(db *sql.DB, username string) error
- func UncreateGroup(db *sql.DB, groupName string) error
- func ValidateEmail(db *sql.DB, username, email string) error
- func ValidateUser(db *sql.DB, username, password string) error
- type Hub
- func (h *Hub) CurrentServiceIsBroken() bool
- func (h *Hub) CurrentServiceName() string
- func (h *Hub) Do(line, username, password, service string, external bool)
- func (h *Hub) DoHubCommand(line string)
- func (h *Hub) GetAndReportErrors(sv *pf.Service)
- func (h *Hub) GetPretty(s string) string
- func (h *Hub) MakeFilepath(scriptFilepath string) string
- func (h *Hub) OpenHubFolder(hubFolder string)
- func (h *Hub) Quit()
- func (h *Hub) Repl()
- func (h *Hub) SaveAndPropagateHubStore()
- func (h *Hub) StartHttp(args []string, isHttps bool)
- func (h *Hub) WriteError(s string)
- func (h *Hub) WritePretty(s string)
- func (h *Hub) WriteString(s string)
Constants ¶
const HELP = "\nUsage: pipefish [-v | --version] [-h | --help]\n" +
" <command> [args]\n\n" +
"Commands are:\n\n" +
" tui Starts the Pipfish TUI (text user interface).\n" +
" run <file> Runs a Pipefish script if it has a `main` command.\n" +
" wiki <file> Returns a description of the file's API in GitHub wiki format.\n\n"
Variables ¶
var ( MARGIN = 92 GREEN_OK = ("\033[32mOK\033[0m") WAS = Green("was") + ": " GOT = Red("got") + ": " TEST_PASSED = Green("Test passed!") + "\n" BULLET = " ▪ " BULLET_SPACING = " " // I.e. whitespace the same width as BULLET. GOOD_BULLET = Green(" ▪ ") BROKEN = Red(" ✖ ") PROMPT = "→ " INDENT_PROMPT = " " ERROR = text.ERROR RT_ERROR = text.ERROR HUB_ERROR = "<R>Hub error</>: " )
Functions ¶
func DropTables ¶
func GetGroupsOfUser ¶
func GetServicesOfUser ¶
func MakePassword ¶
func MakePassword() string
func StartServiceFromCli ¶
func StartServiceFromCli()
func UnLetGroupUseService ¶
Types ¶
type Hub ¶
type Hub struct {
Services map[string]*pf.Service // The services the hub knows about.
Out io.Writer
Sources map[string][]string
Db *sql.DB
// The username and password of the person logged into the terminal.
TerminalUsername string
TerminalPassword string
// contains filtered or unexported fields
}
var TheHub *Hub
func (*Hub) CurrentServiceIsBroken ¶
func (*Hub) CurrentServiceName ¶
func (*Hub) Do ¶
This takes the input from the REPL, interprets it as a hub command if it begins with 'hub'; as an instruction to the os if it begins with '$', and as an expression to be passed to the current service if none of the above hold.
func (*Hub) DoHubCommand ¶
func (*Hub) GetAndReportErrors ¶
func (*Hub) MakeFilepath ¶
func (*Hub) OpenHubFolder ¶
func (*Hub) SaveAndPropagateHubStore ¶
func (h *Hub) SaveAndPropagateHubStore()
Source Files