conf/afm-unit.conf.in

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