Package autoapp

import "bitbucket.org/ares/autoapp"

Overview
Index
Examples
Subdirectories

Overview

Index

Constants
Variables
func GetRootDirs() []string
func ValidateAppName(n string) error
func ValidateAuthor(s string) error
func ValidateCategory(s string) error
func ValidateCategoryGame(s string) error
func ValidateHomepage(s string) error
func ValidateLicense(s string) error
func ValidateVersion(s string) error
type AppFiles
func NewAppFiles(appName *AppName) *AppFiles
func (f *AppFiles) AppendDir(dir string) *AppFiles
func (f *AppFiles) Checking() error
type AppName
func GetAppName(fullName string) (*AppName, error)
func NewAppName(name, version string) *AppName
func (a *AppName) Checking() error
func (a *AppName) FullName() string
func (a *AppName) Name() string
func (a *AppName) SetSystem(os, arch string) error
type Config
func (cfg Config) Check() error
type ExtError
func (e ExtError) Error() string
type HTTPCodeError
func (e HTTPCodeError) Error() string
type Installer
type LicenseType
type NoConfigError
func (e NoConfigError) Error() string
type NoDirError
func (e NoDirError) Error() string
type NoFileError
func (e NoFileError) Error() string
type UserFiles
func NewUserFiles(appName *AppName) *UserFiles

Examples

(Expand All)

AppFiles

Package files

autoapp.go category.go cmd.go config.go file.go file_unix.go installer.go system.go user.go user_linux.go

Constants

const (
    // == Licenses for Open Source Software
    APACHE_2_0 = iota
    GPL_V3
    GPL_V2
    AGPL_V3
    MIT

    ARTISTIC_2_0
    EPL_1_0
    MPL_2_0

    BSD
    BSD_3
    ISC

    UNLICENSE
    CC0_1_0

    // Specific license for commercial software
    COMMERCIAL
)

Identifiers of categories

const (
    BOOKS_AND_REFERENCE = iota
    BUSINESS
    COMICS
    COMMUNICATION
    EDUCATION
    ENTERTAINMENT
    FINANCE
    HEALTH_AND_FITNESS
    LIBRARIES_AND_DEMO
    LIFESTYLE
    APP_WALLPAPER
    MEDIA_AND_VIDEO
    MEDICAL
    MUSIC_AND_AUDIO
    NEWS_AND_MAGAZINES
    PERSONALIZATION
    PHOTOGRAPHY
    PRODUCTIVITY
    SHOPPING
    SOCIAL
    SPORTS
    TOOLS
    TRANSPORTATION
    TRAVEL_AND_LOCAL
    WEATHER
    APP_WIDGETS
    GAME
)

Identifiers of games subcategories

const (
    GAME_ACTION = iota
    GAME_ADVENTURE
    GAME_ARCADE
    GAME_BOARD
    GAME_CARD
    GAME_CASINO
    GAME_CASUAL
    GAME_EDUCATIONAL
    GAME_FAMILY
    GAME_WALLPAPER
    GAME_MUSIC
    GAME_PUZZLE
    GAME_RACING
    GAME_ROLE_PLAYING
    GAME_SIMULATION
    GAME_SPORTS
    GAME_STRATEGY
    GAME_TRIVIA
    GAME_WIDGETS
    GAME_WORD
)

const (
    DIR_APP   = "app"
    DIR_CACHE = "cache"
    DIR_LIB   = "lib"
    DIR_PKG   = "Apps" // or Packages
    DIR_SRV   = "srv"
    DIR_USERS = "Users"

    DIR_BIN    = "bin"  // Executables
    DIR_CONFIG = "conf" // Configuration files
    DIR_DATA   = "data" // Database, cache
    DIR_DOC    = "doc"  // Documentatation
    DIR_LOG    = "log"
    DIR_SHARE  = "share" // Static files to read by the app
    DIR_TOOL   = "tool"  // Scripts/executables to setup extra stuff
    DIR_WEB    = "web"   // User interface based in web
)

const (
    GROUP_USER = "appstore"
    EXT_APP    = ".aapp"
)

const ROOT = "/"

The structure for the root directory of the apps is:

_ ROOT_APP
|
|___ DIR_BIN
|
|___ DIR_CACHE
|
|___ DIR_LIB
|
|___ DIR_PKG
|
|___ DIR_SRV
|
|___ DIR_USERS

const (
    ROOT_APP = ROOT + DIR_APP
)

Variables

var Categories = [...]string{
    BOOKS_AND_REFERENCE: "BOOKS_AND_REFERENCE",
    BUSINESS:            "BUSINESS",
    COMICS:              "COMICS",
    COMMUNICATION:       "COMMUNICATION",
    EDUCATION:           "EDUCATION",
    ENTERTAINMENT:       "ENTERTAINMENT",
    FINANCE:             "FINANCE",
    HEALTH_AND_FITNESS:  "HEALTH_AND_FITNESS",
    LIBRARIES_AND_DEMO:  "LIBRARIES_AND_DEMO",
    LIFESTYLE:           "LIFESTYLE",
    APP_WALLPAPER:       "APP_WALLPAPER",
    MEDIA_AND_VIDEO:     "MEDIA_AND_VIDEO",
    MEDICAL:             "MEDICAL",
    MUSIC_AND_AUDIO:     "MUSIC_AND_AUDIO",
    NEWS_AND_MAGAZINES:  "NEWS_AND_MAGAZINES",
    PERSONALIZATION:     "PERSONALIZATION",
    PHOTOGRAPHY:         "PHOTOGRAPHY",
    PRODUCTIVITY:        "PRODUCTIVITY",
    SHOPPING:            "SHOPPING",
    SOCIAL:              "SOCIAL",
    SPORTS:              "SPORTS",
    TOOLS:               "TOOLS",
    TRANSPORTATION:      "TRANSPORTATION",
    TRAVEL_AND_LOCAL:    "TRAVEL_AND_LOCAL",
    WEATHER:             "WEATHER",
    APP_WIDGETS:         "APP_WIDGETS",
    GAME:                "GAME",
}

var Categories_en = [...]string{
    BOOKS_AND_REFERENCE: "Books & Reference",
    BUSINESS:            "Business",
    COMICS:              "Comics",
    COMMUNICATION:       "Communication",
    EDUCATION:           "Education",
    ENTERTAINMENT:       "Entertainment",
    FINANCE:             "Finance",
    HEALTH_AND_FITNESS:  "Health & Fitness",
    LIBRARIES_AND_DEMO:  "Libraries & Demo",
    LIFESTYLE:           "Lifestyle",
    APP_WALLPAPER:       "Wallpaper",
    MEDIA_AND_VIDEO:     "Media & Video",
    MEDICAL:             "Medical",
    MUSIC_AND_AUDIO:     "Music & Audio",
    NEWS_AND_MAGAZINES:  "News & Magazines",
    PERSONALIZATION:     "Personalization",
    PHOTOGRAPHY:         "Photography",
    PRODUCTIVITY:        "Productivity",
    SHOPPING:            "Shopping",
    SOCIAL:              "Social",
    SPORTS:              "Sports",
    TOOLS:               "Tools",
    TRANSPORTATION:      "Transportation",
    TRAVEL_AND_LOCAL:    "Travel & Local",
    WEATHER:             "Weather",
    APP_WIDGETS:         "Widgets",
    GAME:                "Game",
}

var DIR_HOME string

var Licenses = [...]string{
    APACHE_2_0: "APACHE_2_0",
    GPL_V3:     "GPL_V3",
    GPL_V2:     "GPL_V2",
    AGPL_V3:    "AGPL_V3",
    MIT:        "MIT",

    ARTISTIC_2_0: "ARTISTIC_2_0",
    EPL_1_0:      "EPL_1_0",
    MPL_2_0:      "MPL_2_0",

    BSD:   "BSD",
    BSD_3: "BSD_3",
    ISC:   "ISC",

    UNLICENSE: "UNLICENSE",
    CC0_1_0:   "CC0_1_0",

    COMMERCIAL: "COMMERCIAL",
}

var Licenses_address = [...]string{
    "http://choosealicense.com/licenses/apache-2.0/",
    "http://choosealicense.com/licenses/gpl-3.0/",
    "http://choosealicense.com/licenses/gpl-2.0/",
    "http://choosealicense.com/licenses/agpl-3.0/",
    "http://choosealicense.com/licenses/mit/",

    "http://choosealicense.com/licenses/artistic-2.0/",
    "http://choosealicense.com/licenses/epl-1.0/",
    "http://choosealicense.com/licenses/mpl-2.0/",

    "http://choosealicense.com/licenses/bsd-2-clause/",
    "http://choosealicense.com/licenses/bsd-3-clause/",
    "http://choosealicense.com/licenses/isc/",

    "http://choosealicense.com/licenses/unlicense/",
    "http://choosealicense.com/licenses/cc0/",

    "",
}

var Licenses_string = [...]string{
    APACHE_2_0: "Apache License 2.0",
    GPL_V3:     "GNU GPL v3.0",
    GPL_V2:     "GNU GPL v2.0",
    AGPL_V3:    "GNU Affero GPL v3.0",
    MIT:        "MIT License",

    ARTISTIC_2_0: "Artistic License 2.0",
    EPL_1_0:      "Eclipse Public License v1.0",
    MPL_2_0:      "Mozilla Public License 2.0",

    BSD:   "Simplified BSD",
    BSD_3: "New BSD",
    ISC:   "ISC",

    UNLICENSE: "Public Domain (Unlicense)",
    CC0_1_0:   "CC0 1.0 Universal",

    COMMERCIAL: "commercial",
}

var OrigenDir string

var Pkg = pkg{new(bool)}

var SubcategoriesGames = [...]string{
    GAME_ACTION:       "GAME_ACTION",
    GAME_ADVENTURE:    "GAME_ADVENTURE",
    GAME_ARCADE:       "GAME_ARCADE",
    GAME_BOARD:        "GAME_BOARD",
    GAME_CARD:         "GAME_CARD",
    GAME_CASINO:       "GAME_CASINO",
    GAME_CASUAL:       "GAME_CASUAL",
    GAME_EDUCATIONAL:  "GAME_EDUCATIONAL",
    GAME_FAMILY:       "GAME_FAMILY",
    GAME_WALLPAPER:    "GAME_WALLPAPER",
    GAME_MUSIC:        "GAME_MUSIC",
    GAME_PUZZLE:       "GAME_PUZZLE",
    GAME_RACING:       "GAME_RACING",
    GAME_ROLE_PLAYING: "GAME_ROLE_PLAYING",
    GAME_SIMULATION:   "GAME_SIMULATION",
    GAME_SPORTS:       "GAME_SPORTS",
    GAME_STRATEGY:     "GAME_STRATEGY",
    GAME_TRIVIA:       "GAME_TRIVIA",
    GAME_WIDGETS:      "GAME_WIDGETS",
    GAME_WORD:         "GAME_WORD",
}

var SubcategoriesGames_en = [...]string{
    GAME_ACTION:       "Action",
    GAME_ADVENTURE:    "Adventure",
    GAME_ARCADE:       "Arcade",
    GAME_BOARD:        "Board",
    GAME_CARD:         "Card",
    GAME_CASINO:       "Casino",
    GAME_CASUAL:       "Casual",
    GAME_EDUCATIONAL:  "Educational",
    GAME_FAMILY:       "Family",
    GAME_WALLPAPER:    "Wallpaper",
    GAME_MUSIC:        "Music",
    GAME_PUZZLE:       "Puzzle",
    GAME_RACING:       "Racing",
    GAME_ROLE_PLAYING: "Role Playing",
    GAME_SIMULATION:   "Simulation",
    GAME_SPORTS:       "Sports",
    GAME_STRATEGY:     "Strategy",
    GAME_TRIVIA:       "Trivia",
    GAME_WIDGETS:      "Widgets",
    GAME_WORD:         "Word",
}

var UserCtx userContext

var Verbose *bool

func GetRootDirs

func GetRootDirs() []string

GetRootDirs returns the root directories for the apps.

func ValidateAppName

func ValidateAppName(n string) error

ValidateAppName checks the app name.

It should be all lowercase, with underscores to separate words, just_like_this. Stick with basic Latin letters and Arabic digits: [a-z0-9_] and ensure that it’s a valid Go identifier (i.e. doesn’t start with digits and isn’t a reserved word).

func ValidateAuthor

func ValidateAuthor(s string) error

ValidateAuthor checks whether the email is valid.

func ValidateCategory

func ValidateCategory(s string) error

ValidateCategory checks that the category is valid.

func ValidateCategoryGame

func ValidateCategoryGame(s string) error

ValidateCategoryGame checks that the subcategory of game is valid.

func ValidateHomepage

func ValidateHomepage(s string) error

ValidateHomepage checks whether the home page is an URL valid.

func ValidateLicense

func ValidateLicense(s string) error

ValidateLicense checks whether the license is valid.

func ValidateVersion

func ValidateVersion(s string) error

ValidateVersion checks that the version follows semantic versioning (http://semver.org/).

type AppFiles

AppFiles represents the directory structure for an app.

The structure is:

_ ROOT_PKG/[name]/[version]/
|
|___ DIR_BIN
|
|___ DIR_CONFIG
|
|___ DIR_DATA
|
|___ DIR_DOC
|
|___ DIR_SHARE
|
|___ DIR_TOOL
|
|___ DIR_WEB

type AppFiles struct {

    // Files in root directory
    F_Changelog string
    F_Readme    string
    F_Spec      string

    // Directories
    D_Bin    string
    D_Config string
    D_Data   string
    D_Doc    string
    D_Share  string
    D_Tool   string
    D_Web    string

    // Files in subdirectories
    F_Config_ string
    // contains filtered or unexported fields
}

Example

Code:

appName := NewAppName(APP_NAME, APP_VERSION)

appFiles := NewAppFiles(appName)
userFiles := NewUserFiles(appName)
fmt.Println(appFiles)
fmt.Println(userFiles)

Output:

&{/app/Apps/foo/1.0.0 CHANGELOG.md README.md spec.yaml bin conf data doc share tool web }
&{/app/Users /app/Users/conf/foo/1.0.0.cfg /app/Users/data/foo/1.0.0 /app/Users/log/foo/1.0.0.log}

func NewAppFiles

func NewAppFiles(appName *AppName) *AppFiles

func (*AppFiles) AppendDir

func (f *AppFiles) AppendDir(dir string) *AppFiles

AppendDir appends a directory in every path.

func (*AppFiles) Checking

func (f *AppFiles) Checking() error

Checking checks that the files exist and correspond to the file type.

type AppName

AppName represents the full name of an app.

type AppName struct {
    // contains filtered or unexported fields
}

func GetAppName

func GetAppName(fullName string) (*AppName, error)

GetAppName slices "fullName" into all substrings separated by "-" and returns an "AppName" with the substrings between those separators.

func NewAppName

func NewAppName(name, version string) *AppName

NewAppName returns an AppName with both operating system and architecture for the current system.

func (*AppName) Checking

func (a *AppName) Checking() error

Checking checks that the app name and version are right.

func (*AppName) FullName

func (a *AppName) FullName() string

FullName returns the full name of an app.

func (*AppName) Name

func (a *AppName) Name() string

func (*AppName) SetSystem

func (a *AppName) SetSystem(os, arch string) error

SetSystem sets both operating system and architecture.

type Config

Config represents the configuration of an "autoapp" package.

type Config struct {
    Name        string // Required
    Version     string // Required
    Description string // Required
    Author      string
    Authors     []string
    Homepage    string

    License     string // Required
    LicenseText string // For commercial licenses

    Category string // Required // TODO: mayve Section ???
    Game     string // Subcategory
}

func (Config) Check

func (cfg Config) Check() error

Check checks that the configuration have all required fields and validate the values.

type ExtError

ExtError reports incorrect extension for an app.

type ExtError string

func (ExtError) Error

func (e ExtError) Error() string

type HTTPCodeError

type HTTPCodeError int

func (HTTPCodeError) Error

func (e HTTPCodeError) Error() string

type Installer

Installer is the interface to handle tasks related at installing and removing of apps.

type Installer interface {
    Install() error
    Remove() error
}

type LicenseType

type LicenseType int

type NoConfigError

A NoConfigError reports the absence of configuration file.

type NoConfigError string

func (NoConfigError) Error

func (e NoConfigError) Error() string

type NoDirError

NoDirError reports when a file is not a directory.

type NoDirError string

func (NoDirError) Error

func (e NoDirError) Error() string

type NoFileError

NoFileError reports when a file is not regular.

type NoFileError string

func (NoFileError) Error

func (e NoFileError) Error() string

type UserFiles

UserFiles represents the directory structure of the user files for an app.

The structure is:

_ ROOT_USER/[user name]/
|
|___ DIR_CONFIG/[app name]/[app version].cfg
|
|___ DIR_DATA/[app name]/[app version]/
|
|___ DIR_LOG/[app name]/[app version].log

type UserFiles struct {
    F_Config string
    D_Data   string
    F_Log    string
    // contains filtered or unexported fields
}

func NewUserFiles

func NewUserFiles(appName *AppName) *UserFiles

Subdirectories

Name	Synopsis

appconf
cmd
cmd/autoapp
cmd/autoapp.root

bitbucket.org/ares/autoapp

autoapp

Installation

Create sytem group/user and apps directory

Remove sytem group/user and full directory of apps

License