conf/unit/afm-unit.conf.in

   1 ;-------------------------------------------------------------------------------
   2 ; File:
   3 ;
   4 ;    afm-unit.conf
   5 ;
   6 ; Mode:
   7 ;
   8 ;    RELEASE
   9 ;
  10 ; Role:
  11 ;
  12 ;    Configure how installation of widget produces unit files for systemd
  13 ;
  14 ; Processing and format:
  15 ;
  16 ;    1. File load
  17 ;
  18 ;           Lines beginning with ; are firstly removed
  19 ;
  20 ;    2. File instantiation
  21 ;
  22 ;           Mustache (extended) substitutions are applied using JSON
  23 ;           data deduced from config.xml file of the widget.
  24 ;
  25 ;    3. Extraction of units
  26 ;
  27 ;           Extract produced units, pack it (remove empty lines and directives)
  28 ;
  29 ; Directives:
  30 ;
  31 ;    Any directive occupy one whole line starting with %
  32 ;
  33 ;     - %nl
  34 ;
  35 ;             produce an empty line at the end
  36 ;
  37 ;     - %begin systemd-unit
  38 ;     - %end systemd-unit
  39 ;
  40 ;             delimit the produced unit
  41 ;
  42 ;     - %systemd-unit user
  43 ;     - %systemd-unit system
  44 ;
  45 ;             tells the kind of unit (user/system)
  46 ;
  47 ;     - %systemd-unit service NAME
  48 ;     - %systemd-unit socket NAME
  49 ;
  50 ;             gives the name and type of the unit
  51 ;
  52 ;     - %systemd-unit wanted-by NAME
  53 ;
  54 ;             tells to install a link to unit in the wants of NAME
  55 ;
  56 ; Setting variables:
  57 ;
  58 ;    AFM uses the feature of systemd that completely ignores options prefixed
  59 ;    with X-
  60 ;
  61 ;    Consequently, options starting with X-AFM- are recorded as public data
  62 ;    about the application and options starting starting with X-AFM-- are
  63 ;    recorded as private data.
  64 ;
  65 ;    Examples:
  66 ;
  67 ;        X-AFM-description={{description}}
  68 ;
  69 ;              Records the description of the unit in the field "description"
  70 ;              of both the public and private object describing the unit.
  71 ;
  72 ;        X-AFM--wgtdir={{:#metadata.install-dir}}
  73 ;
  74 ;              Records the installation directory path in the field "wgtdir"
  75 ;              of the private object only.
  76 ;
  77 ;-------------------------------------------------------------------------------
  78 ;----        F O R E A C H   T A R G E T                                    ----
  79 ;-------------------------------------------------------------------------------
  80 {{#targets}}
  81 ;-------------------------------------------------------------------------------
  82 ;-------------------------------------------------------------------------------
  83 ;----         M A I N    P A R T    O F   T H E   S E R V I C E             ----
  84 ;-------------------------------------------------------------------------------
  85 %begin systemd-unit
  86 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
  87 %nl
  88 %systemd-unit system
  89 %systemd-unit service afm-{{#required-permission.@afm_prefix@permission::public:hidden}}service{{/required-permission.@afm_prefix@permission::public:hidden}}{{^required-permission.@afm_prefix@permission::public:hidden}}appli{{/required-permission.@afm_prefix@permission::public:hidden}}-{{:id}}--{{:ver}}--{{:#target}}@
  90 [Unit]
  91 Description={{description}}
  92 X-AFM-description={{description}}
  93 X-AFM-name={{name.content}}
  94 X-AFM-shortname={{name.short}}
  95 X-AFM-id={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
  96 X-AFM-version={{:version}}
  97 X-AFM-author={{author.content}}
  98 X-AFM-author-email={{author.email}}
  99 X-AFM-width={{width}}
 100 X-AFM-height={{height}}
 101 {{#icon}}
 102 X-AFM-icon={{:#metadata.install-dir}}/{{:src}}
 103 {{/icon}}
 104 X-AFM--ID={{:id}}
 105 X-AFM--target-name={{:#target}}
 106 X-AFM--content={{content.src}}
 107 X-AFM--type={{content.type}}
 108 X-AFM--wgtdir={{:#metadata.install-dir}}
 109 X-AFM--workdir=/home/%i/app-data/{{:id}}
 110 X-AFM--visibility={{#required-permission.@afm_prefix@permission::public:hidden}}hidden{{/required-permission.@afm_prefix@permission::public:hidden}}{{^required-permission.@afm_prefix@permission::public:hidden}}visible{{/required-permission.@afm_prefix@permission::public:hidden}}
 111 %nl
 112 Requires=afm-user-session@%i.target
 113 After=user@%i.service
 114 After=Network.target
 115 # Adds check to smack
 116 ConditionSecurity=smack
 117 %nl
 118 # Automatic bound to required api
 119 {{#required-binding}}
 120 {{#value=extern}}
 121 BindsTo=afm-link-{{name}}@%i.service
 122 After=afm-link-{{name}}@%i.service
 123 {{/value=extern}}
 124 {{/required-binding}}
 125 {{#required-api}}
 126 {{#value=auto|ws}}
 127 BindsTo=afm-api-{{name}}@%i.service
 128 After=afm-api-{{name}}@%i.service
 129 {{/value=auto|ws}}
 130 {{/required-api}}
 131 {{#provided-api}}
 132 {{#value=ws|auto}}
 133 Requires=afm-api-{{name}}@%i.socket
 134 After=afm-api-{{name}}@%i.socket
 135 {{/value=ws|auto}}
 136 {{/provided-api}}
 137 %nl
 138 [Service]
 139 EnvironmentFile=-@afm_confdir@/unit.env.d/*
 140 EnvironmentFile=-@afm_confdir@/widget.env.d/{{:id}}/*
 141 SmackProcessLabel=User::App::{{:id}}
 142 SuccessExitStatus=0 SIGKILL
 143 User=%i
 144 Slice=user-%i.slice
 145 CapabilityBoundingSet=
 146 #AmbientCapabilities=
 147 {{#required-permission.@afm_prefix@permission::platform:no-oom}}OOMScoreAdjust=-500{{/required-permission.@afm_prefix@permission::platform:no-oom}}
 148 {{#required-permission.@afm_prefix@permission::partner:real-time}}IOSchedulingClass=realtime{{/required-permission.@afm_prefix@permission::partner:real-time}}
 149 {{#required-permission.@afm_prefix@permission::public:display}}SupplementaryGroups=display{{/required-permission.@afm_prefix@permission::public:display}}
 150 {{^required-permission.@afm_prefix@permission::public:syscall:clock}}SystemCallFilter=~@clock{{/required-permission.@afm_prefix@permission::public:syscall:clock}}
 151 %nl
 152 WorkingDirectory=-/home/%i/app-data/{{:id}}
 153 ExecStartPre=/bin/mkdir -p /home/%i/app-data/{{:id}}
 154 Environment=AFM_ID={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 155 Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}}
 156 Environment=AFM_WORKDIR=/home/%i/app-data/{{:id}}
 157 Environment=AFM_WSAPI_DIR=@afm_users_rundir@/%i/apis/ws
 158 Environment=PATH=/usr/sbin:/usr/bin:/sbin:/bin:{{:#metadata.install-dir}}/bin
 159 Environment=LD_LIBRARY_PATH={{:#metadata.install-dir}}/lib
 160 Environment=XDG_DATA_HOME=/home/%i/app-data/{{:id}}
 161 Environment=XDG_CONFIG_HOME=/home/%i/app-data/{{:id}}
 162 Environment=XDG_CACHE_HOME=/home/%i/app-data/{{:id}}
 163 Environment=XDG_RUNTIME_DIR=@afm_users_rundir@/%i
 164 Environment=DBUS_SESSION_BUS_ADDRESS=unix:path=@afm_users_rundir@/%i/bus
 165 SyslogIdentifier=afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 166 StandardInput=null
 167 StandardOutput=journal
 168 StandardError=journal
 169 ;-------------------------------------------------------------------------------
 170 ;----   text/html  application/vnd.agl.native  application/vnd.agl.service  ----
 171 ;-------------------------------------------------------------------------------
 172 {{#content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 173 {{^content.type=application/vnd.agl.service}}
 174 X-AFM--http-port={{:#metatarget.http-port}}
 175 {{/content.type=application/vnd.agl.service}}
 176 Type=notify
 177 ExecStart=/usr/bin/afb-daemon \
 178         --name afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}} \
 179         --rootdir={{:#metadata.install-dir}} \
 180         --workdir=/home/%i/app-data/{{id}} \
 181         {{#content.type=application/vnd.agl.service}} \
 182                 --no-httpd \
 183         {{/content.type=application/vnd.agl.service}}{{^content.type=application/vnd.agl.service}} \
 184                 --port={{:#metatarget.http-port}} \
 185                 --random-token \
 186                 --roothttp={{#required-permission.@afm_prefix@permission::public:no-htdocs}}.{{/required-permission.@afm_prefix@permission::public:no-htdocs}}{{^required-permission.@afm_prefix@permission::public:no-htdocs}}htdocs{{/required-permission.@afm_prefix@permission::public:no-htdocs}} \
 187         {{/content.type=application/vnd.agl.service}} \
 188         {{#required-permission.@afm_prefix@permission::public:applications:read}}--alias=/icons:{{:#metadata.icons-dir}}{{/required-permission.@afm_prefix@permission::public:applications:read}} \
 189         {{#required-api}} \
 190                 {{#value=auto|ws}}--ws-client=unix:@afm_users_rundir@/%i/apis/ws/{{name}}{{/value=auto|ws}} \
 191                 {{#value=dbus}}--dbus-client={{name}}{{/value=dbus}} \
 192                 {{#value=cloud}}--cloud-client={{name}}{{/value=cloud}} \
 193                 {{#value=local}}--binding={{:#metadata.install-dir}}/{{name}}{{/value=local}} \
 194                 {{#value=tcp}}--ws-client=tcp:{{name}}{{/value=tcp}} \
 195         {{/required-api}} \
 196         {{#required-binding}} \
 197                 {{#value=local}}--binding={{:#metadata.install-dir}}/{{name}}{{/value=local}} \
 198                 {{#value=extern}}--binding=@afm_users_rundir@/%i/apis/link/{{name}}{{/value=extern}} \
 199         {{/required-binding}} \
 200         {{#provided-api}} \
 201                 {{#value=auto|ws}}--ws-server=sd:{{name}}{{/value=auto|ws}} \
 202                 {{#value=dbus}}--dbus-server={{name}}{{/value=dbus}} \
 203                 {{#value=tcp}}--ws-server=tcp:{{name}}{{/value=tcp}} \
 204         {{/provided-api}} \
 205         {{#content.type=text/html}}--exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t{{/content.type=text/html}} \
 206         {{#content.type=application/vnd.agl.native}}--exec {{:#metadata.install-dir}}/{{content.src}} @p @t{{/content.type=application/vnd.agl.native}}
 207 {{/content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 208 ;-------------------------------------------------------------------------------
 209 ;----                 application/x-executable                              ----
 210 ;-------------------------------------------------------------------------------
 211 {{#content.type=application/x-executable}}
 212 ExecStart={{:#metadata.install-dir}}/{{content.src}}
 213 {{/content.type=application/x-executable}}
 214 {{#required-permission.@afm_prefix@permission::system:run-by-default}}
 215 ;-------------------------------------------------------------------------------
 216 ; auto start
 217 ;-------------------------------------------------------------------------------
 218 [Install]
 219 WantedBy=afm-user-session@.target
 220 %systemd-unit wanted-by afm-user-session@.target
 221 {{/required-permission.@afm_prefix@permission::system:run-by-default}}
 222 %end systemd-unit
 223 ;-------------------------------------------------------------------------------
 224 ;----        F O R E A C H   P R O V I D E D   A P I S                      ----
 225 ;-------------------------------------------------------------------------------
 226 {{#provided-api}}
 227 {{#value=ws|auto}}
 228 ;-------------------------------------------------------------------------------
 229 ;----        T H E   S E R V I C E   O F   T H E   A P I                    ----
 230 ;-------------------------------------------------------------------------------
 231 %begin systemd-unit
 232 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 233 %systemd-unit system
 234 %systemd-unit service afm-api-{{name}}@
 235 [Unit]
 236 Description=Provides api {{name}} for user %i
 237 X-AFM-API-TYPE={{value}}
 238 Requires=afm-user-setup@%i.service
 239 After=afm-user-setup@%i.service
 240 Requires=afm-api-{{name}}@%i.socket
 241 After=afm-api-{{name}}@%i.socket
 242 [Service]
 243 Type=oneshot
 244 RemainAfterExit=yes
 245 ExecStart=/bin/true
 246 %end systemd-unit
 247 ;-------------------------------------------------------------------------------
 248 ;----        T H E   S O C K E T   O F   T H E   A P I                      ----
 249 ;-------------------------------------------------------------------------------
 250 %begin systemd-unit
 251 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 252 %systemd-unit system
 253 %systemd-unit socket afm-api-{{name}}@
 254 [Unit]
 255 Description=Provides websocket api {{name}} for user %i
 256 Requires=afm-user-setup@%i.service
 257 After=afm-user-setup@%i.service
 258 DefaultDependencies=no
 259 [Socket]
 260 SmackLabel=*
 261 SmackLabelIPIn=System
 262 SmackLabelIPOut=System
 263 ListenStream=@afm_users_rundir@/%i/apis/ws/{{name}}
 264 FileDescriptorName={{name}}
 265 Service=afm-{{#required-permission.@afm_prefix@permission::public:hidden}}service{{/required-permission.@afm_prefix@permission::public:hidden}}{{^required-permission.@afm_prefix@permission::public:hidden}}appli{{/required-permission.@afm_prefix@permission::public:hidden}}-{{:id}}--{{:ver}}--{{:#target}}@%i.service
 266 %end systemd-unit
 267 {{/value=ws|auto}}
 268 {{/provided-api}}
 269 ;-------------------------------------------------------------------------------
 270 ;----        F O R E A C H   P R O V I D E D   B I N D I N G                ----
 271 ;-------------------------------------------------------------------------------
 272 {{#provided-binding}}
 273 ;-------------------------------------------------------------------------------
 274 ;----        T H E   S E R V I C E   O F   T H E   B I N D I N G            ----
 275 ;-------------------------------------------------------------------------------
 276 %begin systemd-unit
 277 # auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}}
 278 %systemd-unit system
 279 %systemd-unit service afm-link-{{name}}@
 280 [Unit]
 281 Description=Provides binding {{name}} for user %i
 282 Requires=afm-user-setup@%i.service
 283 After=afm-user-setup@%i.service
 284 [Service]
 285 Type=oneshot
 286 RemainAfterExit=yes
 287 ExecStart=/bin/ln -sf {{:#metadata.install-dir}}/{{value}} @afm_users_rundir@/%i/apis/link/{{name}}
 288 %end systemd-unit
 289 {{/provided-binding}}
 290 ;-------------------------------------------------------------------------------
 291 {{/targets}}
 292 ;-------------------------------------------------------------------------------
 293 ; End of file afm-unit.conf mode RELEASE
 294 ;-------------------------------------------------------------------------------