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 X-AFM-id={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
  90 X-AFM-version={{version}}
  91 X-AFM-author={{author.content}}
  92 X-AFM-author-email={{author.email}}
  93 X-AFM-width={{width}}
  94 X-AFM-height={{height}}
  95 X-AFM--ID={{id}}
  96 X-AFM--target-name={{:#target}}
  97 X-AFM--content={{content.src}}
  98 X-AFM--type={{content.type}}
  99 X-AFM--wgtdir={{:#metadata.install-dir}}
 100 X-AFM--workdir={{&#metadata.app-data-dir}}/{{id}}
 101 %nl
 102
 103 Wants=sockets.target
 104
 105 # Adds check to smack
 106 ConditionSecurity=smack
 107 %nl
 108
 109 # Automatic bound to required api
 110 {{#required-api}}
 111 {{#value=auto|ws}}
 112 BindsTo=afm-api-ws-{{name}}.socket
 113 After=afm-api-ws-{{name}}.socket
 114 {{/value=auto|ws}}
 115 {{/required-api}}
 116 %nl
 117
 118 [Service]
 119 EnvironmentFile=-@afm_confdir@/unit.env.d/*
 120 SmackProcessLabel=User::App::{{id}}
 121 SuccessExitStatus=0 SIGKILL
 122
 123 {{#required-permission}}
 124   {{#urn:AGL:permission::platform:no-oom}}      OOMScoreAdjust=-500             {{/urn:AGL:permission::platform:no-oom}}
 125   {{#urn:AGL:permission::partner:real-time}}    IOSchedulingClass=realtime      {{/urn:AGL:permission::partner:real-time}}
 126 #  {{^urn:AGL:permission::partner:real-time}}    RestrictRealtime=on             {{/urn:AGL:permission::partner:real-time}}
 127   {{#urn:AGL:permission::public:display}}       SupplementaryGroups=display     {{/urn:AGL:permission::public:display}}
 128   {{^urn:AGL:permission::public:syscall:clock}} SystemCallFilter=~@clock        {{/urn:AGL:permission::public:syscall:clock}}
 129 {{/required-permission}}
 130 %nl
 131
 132 WorkingDirectory=-{{&#metadata.app-data-dir}}/{{id}}
 133 ExecStartPre=/bin/mkdir -p {{&#metadata.app-data-dir}}/{{id}}
 134 Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}}
 135 Environment=PATH=/usr/sbin:/usr/bin:/sbin:/bin:{{:#metadata.install-dir}}
 136
 137 %systemd-unit user
 138 {{#required-permission.urn:AGL:permission::public:hidden}}\
 139 %systemd-unit service afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 140 {{/required-permission.urn:AGL:permission::public:hidden}}\
 141 {{^required-permission.urn:AGL:permission::public:hidden}}\
 142 %systemd-unit service afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 143 {{/required-permission.urn:AGL:permission::public:hidden}}\
 144
 145 Environment=LD_LIBRARY_PATH=$ORIGIN/lib
 146
 147 SyslogIdentifier=afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 148 StandardInput=null
 149 StandardOutput=journal
 150 StandardError=journal
 151
 152 ;---------------------------------------------------------------------------------
 153 ;----   text/html  application/vnd.agl.native  application/vnd.agl.service    ----
 154 ;---------------------------------------------------------------------------------
 155 {{#content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 156
 157 {{^content.type=application/vnd.agl.service}}
 158 X-AFM--http-port={{:#metadata.http-port}}
 159 {{/content.type=application/vnd.agl.service}}
 160
 161 ExecStart=/usr/bin/afb-daemon \
 162         --name afbd-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}} \
 163         --rootdir={{:#metadata.install-dir}} \
 164         --workdir={{&#metadata.app-data-dir}}/{{id}} \
 165         {{#content.type=application/vnd.agl.service}}\
 166                 --no-httpd \
 167         {{/content.type=application/vnd.agl.service}}\
 168         {{^content.type=application/vnd.agl.service}}\
 169                 --port={{:#metadata.http-port}} \
 170                 --random-token \
 171                 {{#required-permission.urn:AGL:permission::public:no-htdocs}}\
 172                         --roothttp=. \
 173                 {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
 174                 {{^required-permission.urn:AGL:permission::public:no-htdocs}}\
 175                         --roothttp=htdocs \
 176                 {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
 177         {{/content.type=application/vnd.agl.service}}\
 178         {{#required-permission.urn:AGL:permission::public:applications:read}}\
 179                 --alias=/icons:{{:#metadata.icons-dir}} \
 180         {{/required-permission.urn:AGL:permission::public:applications:read}}\
 181         {{#required-api}}\
 182                 {{#value=auto}}\
 183                         --ws-client=unix:%t/apis/ws/{{name}} \
 184                 {{/value=auto}}\
 185                 {{#value=ws}}\
 186                         --ws-client=unix:%t/apis/ws/{{name}} \
 187                 {{/value=ws}}\
 188                 {{#value=dbus}}\
 189                         --dbus-client={{name}} \
 190                 {{/value=dbus}}\
 191                 {{#value=link}}\
 192                         --binding=%t/apis/lib/{{name}} \
 193                 {{/value=link}}\
 194                 {{#value=cloud}}\
 195                         --cloud-client={{name}} \
 196                 {{/value=cloud}}\
 197                 {{#value=local}}\
 198                         --binding={{:#metadata.install-dir}}/{{name}} \
 199                 {{/value=local}}\
 200         {{/required-api}}\
 201         {{#provided-api}}\
 202                 {{#value=auto}}\
 203                         {{^required-permission.urn:AGL:permission::partner:service:no-ws}}\
 204                                 --ws-server=sd:{{name}} \
 205                         {{/required-permission.urn:AGL:permission::partner:service:no-ws}}\
 206                         {{^required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 207                                 --dbus-server={{name}} \
 208                         {{/required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 209                 {{/value=auto}}\
 210                 {{#value=ws}}\
 211                         --ws-server=sd:{{name}} \
 212                 {{/value=ws}}\
 213                 {{#value=dbus}}\
 214                         --dbus-server={{name}} \
 215                 {{/value=dbus}}\
 216         {{/provided-api}}\
 217         {{#content.type=text/html}}\
 218                 --exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t
 219         {{/content.type=text/html}}\
 220         {{#content.type=application/vnd.agl.native}}\
 221                 --exec {{:#metadata.install-dir}}/{{content.src}} @p @t
 222         {{/content.type=application/vnd.agl.native}}
 223
 224 {{/content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}}
 225
 226
 227 ;---------------------------------------------------------------------------------
 228 ;----                 application/x-executable                                ----
 229 ;---------------------------------------------------------------------------------
 230 {{#content.type=application/x-executable}}
 231
 232 ExecStart={{:#metadata.install-dir}}/{{content.src}}
 233
 234 {{/content.type=application/x-executable}}
 235
 236 ;---------------------------------------------------------------------------------
 237 ; auto start
 238 ;---------------------------------------------------------------------------------
 239 {{#required-permission.urn:AGL:permission::system:run-by-default}}
 240 %nl
 241 [Install]
 242 WantedBy=default.target
 243 %systemd-unit wanted-by default.target
 244 {{/required-permission.urn:AGL:permission::system:run-by-default}}
 245
 246 %end systemd-unit
 247
 248
 249 ;---------------------------------------------------------------------------------
 250 ;----        P R O V I D E D   A P I S                                        ----
 251 ;---------------------------------------------------------------------------------
 252
 253 {{#provided-api}}
 254 {{#value=ws|auto}}
 255
 256 %begin systemd-unit
 257
 258 # auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}} of {{idaver}}
 259 #
 260 %systemd-unit user
 261 %systemd-unit socket afm-api-ws-{{name}}
 262
 263 [Socket]
 264 SmackLabel=*
 265 ListenStream=%t/apis/ws/{{name}}
 266 FileDescriptorName={{name}}
 267
 268 {{#required-permission.urn:AGL:permission::public:hidden}}\
 269 Service=afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}.service
 270 {{/required-permission.urn:AGL:permission::public:hidden}}\
 271 {{^required-permission.urn:AGL:permission::public:hidden}}\
 272 Service=afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}.service
 273 {{/required-permission.urn:AGL:permission::public:hidden}}\
 274
 275 ;---------------------------------------------------------------------------------
 276 %nl
 277 [Install]
 278 WantedBy=sockets.target
 279 %systemd-unit wanted-by sockets.target
 280 ;---------------------------------------------------------------------------------
 281
 282 %end systemd-unit
 283
 284 {{/value=ws|auto}}
 285 {{/provided-api}}
 286
 287 {{/targets}}
 288