<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kinit: kstartupconfig.cpp Source File (kinit)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kinit</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div class="header">
<div class="headertitle">
<div class="title">kstartupconfig.cpp</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/****************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Copyright (C) 2005 Lubos Lunak <l.lunak@kde.org></span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">Permission is hereby granted, free of charge, to any person obtaining a</span>
<a name="l00006"></a>00006 <span class="comment">copy of this software and associated documentation files (the "Software"),</span>
<a name="l00007"></a>00007 <span class="comment">to deal in the Software without restriction, including without limitation</span>
<a name="l00008"></a>00008 <span class="comment">the rights to use, copy, modify, merge, publish, distribute, sublicense,</span>
<a name="l00009"></a>00009 <span class="comment">and/or sell copies of the Software, and to permit persons to whom the</span>
<a name="l00010"></a>00010 <span class="comment">Software is furnished to do so, subject to the following conditions:</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment">The above copyright notice and this permission notice shall be included in</span>
<a name="l00013"></a>00013 <span class="comment">all copies or substantial portions of the Software.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00016"></a>00016 <span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00017"></a>00017 <span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL</span>
<a name="l00018"></a>00018 <span class="comment">THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00019"></a>00019 <span class="comment">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
<a name="l00020"></a>00020 <span class="comment">FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span>
<a name="l00021"></a>00021 <span class="comment">DEALINGS IN THE SOFTWARE.</span>
<a name="l00022"></a>00022 <span class="comment"></span>
<a name="l00023"></a>00023 <span class="comment">****************************************************************************/</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">/*</span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment">This utility helps to have some configuration options available in startkde</span>
<a name="l00028"></a>00028 <span class="comment">without the need to launch anything linked to KDE libraries (which may need</span>
<a name="l00029"></a>00029 <span class="comment">some time to load).</span>
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment">The configuration options are written to $KDEHOME/share/config/startupconfigkeys,</span>
<a name="l00032"></a>00032 <span class="comment">one option per line, as <file> <group> <key> <default>. It is possible to</span>
<a name="l00033"></a>00033 <span class="comment">use ' for quoting multiword entries. Values of these options will be written</span>
<a name="l00034"></a>00034 <span class="comment">to $KDEHOME/share/config/startupconfig as a shell script that will set</span>
<a name="l00035"></a>00035 <span class="comment">the values to shell variables, named <file>_<group>_<key> (all spaces replaced</span>
<a name="l00036"></a>00036 <span class="comment">by underscores, everything lowercase). So e.g. line</span>
<a name="l00037"></a>00037 <span class="comment">"ksplashrc KSplash Theme Default" may result in "ksplashrc_ksplash_theme=Default".</span>
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">In order to real a whole group it is possible to use <file> <[group]>, e.g.</span>
<a name="l00040"></a>00040 <span class="comment">"ksplashrc [KSplash]", which will set shell variables for all keys in the group.</span>
<a name="l00041"></a>00041 <span class="comment">It is not possible to specify default values, but since the configuration options</span>
<a name="l00042"></a>00042 <span class="comment">are processed in the order they are specified this can be solved by first</span>
<a name="l00043"></a>00043 <span class="comment">specifying a group and then all the entries that need default values.</span>
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">When a kconf_update script is used to update such option, kstartupconfig is run</span>
<a name="l00046"></a>00046 <span class="comment">before kconf_update and therefore cannot see the change in time. To avoid this</span>
<a name="l00047"></a>00047 <span class="comment">problem, together with the kconf_update script also the matching global config</span>
<a name="l00048"></a>00048 <span class="comment">file should be updated (any change, kstartupconfig will see the timestamp change).</span>
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment">Note that the kdeglobals config file is not used as a depedendency for other config</span>
<a name="l00051"></a>00051 <span class="comment">files.</span>
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment">Since the checking is timestamp-based, config files that are frequently updated</span>
<a name="l00054"></a>00054 <span class="comment">should not be used.</span>
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">Kstartupconfig works by storing every line from startupconfigkeys in file startupconfigfiles</span>
<a name="l00057"></a>00057 <span class="comment">followed by paths of all files that are relevant to the option. Non-existent files</span>
<a name="l00058"></a>00058 <span class="comment">have '!' prepended (for the case they'll be later created), the list of files is</span>
<a name="l00059"></a>00059 <span class="comment">terminated by line containing '*'. If the timestamps of all relevant files are older</span>
<a name="l00060"></a>00060 <span class="comment">than the timestamp of the startupconfigfile file, there's no need to update anything.</span>
<a name="l00061"></a>00061 <span class="comment">Otherwise kdostartupconfig is launched to create or update all the necessary files</span>
<a name="l00062"></a>00062 <span class="comment">(which already requires loading KDE libraries, but this case should be rare).</span>
<a name="l00063"></a>00063 <span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment">*/</span>
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="preprocessor">#include <config.h></span>
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="preprocessor">#include <sys/types.h></span>
<a name="l00069"></a>00069 <span class="preprocessor">#include <sys/stat.h></span>
<a name="l00070"></a>00070 <span class="preprocessor">#include <sys/wait.h></span>
<a name="l00071"></a>00071 <span class="preprocessor">#include <unistd.h></span>
<a name="l00072"></a>00072 <span class="preprocessor">#include <stdio.h></span>
<a name="l00073"></a>00073 <span class="preprocessor">#include <string.h></span>
<a name="l00074"></a>00074 <span class="preprocessor">#include <stdlib.h></span>
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keywordtype">int</span> main()
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 <span class="keywordtype">char</span> kdehome[ 1024 ];
<a name="l00079"></a>00079 <span class="keywordflow">if</span>( getenv( <span class="stringliteral">"KDEHOME"</span> ))
<a name="l00080"></a>00080 strlcpy( kdehome, getenv( <span class="stringliteral">"KDEHOME"</span> ), 1024 );
<a name="l00081"></a>00081 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( getenv( <span class="stringliteral">"HOME"</span> ))
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 strlcpy( kdehome, getenv( <span class="stringliteral">"HOME"</span> ), 1024 );
<a name="l00084"></a>00084 strlcat( kdehome, <span class="stringliteral">"/.kde"</span>, 1024 );
<a name="l00085"></a>00085 }
<a name="l00086"></a>00086 <span class="keywordflow">else</span>
<a name="l00087"></a>00087 <span class="keywordflow">return</span> 1;
<a name="l00088"></a>00088 <span class="keywordtype">char</span> filename[ 1024 ];
<a name="l00089"></a>00089 strlcpy( filename, kdehome, 1024 );
<a name="l00090"></a>00090 strlcat( filename, <span class="stringliteral">"/share/config/startupconfig"</span>, 1024 );
<a name="l00091"></a>00091 <span class="keywordflow">if</span>( access( filename, R_OK ) != 0 )
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093 <span class="keywordtype">int</span> ret = system( <span class="stringliteral">"kdostartupconfig"</span> );
<a name="l00094"></a>00094 <span class="keywordflow">return</span> WEXITSTATUS( ret );
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096 strlcpy( filename, kdehome, 1024 );
<a name="l00097"></a>00097 strlcat( filename, <span class="stringliteral">"/share/config/startupconfigfiles"</span>, 1024 );
<a name="l00098"></a>00098 <span class="keyword">struct </span>stat st;
<a name="l00099"></a>00099 <span class="keywordflow">if</span>( stat( filename, &st ) != 0 )
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 <span class="keywordtype">int</span> ret = system( <span class="stringliteral">"kdostartupconfig"</span> );
<a name="l00102"></a>00102 <span class="keywordflow">return</span> WEXITSTATUS( ret );
<a name="l00103"></a>00103 }
<a name="l00104"></a>00104 time_t config_time = st.st_mtime;
<a name="l00105"></a>00105 FILE* config = fopen( filename, <span class="stringliteral">"r"</span> );
<a name="l00106"></a>00106 <span class="keywordflow">if</span>( config == NULL )
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108 <span class="keywordtype">int</span> ret = system( <span class="stringliteral">"kdostartupconfig"</span> );
<a name="l00109"></a>00109 <span class="keywordflow">return</span> WEXITSTATUS( ret );
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 strlcpy( filename, kdehome, 1024 );
<a name="l00112"></a>00112 strlcat( filename, <span class="stringliteral">"/share/config/startupconfigkeys"</span>, 1024 );
<a name="l00113"></a>00113 FILE* keys = fopen( filename, <span class="stringliteral">"r"</span> );
<a name="l00114"></a>00114 <span class="keywordflow">if</span>( keys == NULL )
<a name="l00115"></a>00115 {
<a name="l00116"></a>00116 fclose( config );
<a name="l00117"></a>00117 <span class="keywordflow">return</span> 2;
<a name="l00118"></a>00118 }
<a name="l00119"></a>00119 <span class="keywordtype">bool</span> need_update = <span class="keyword">true</span>;
<a name="l00120"></a>00120 <span class="keywordflow">for</span>(;;)
<a name="l00121"></a>00121 {
<a name="l00122"></a>00122 <span class="keywordtype">char</span> keyline[ 1024 ];
<a name="l00123"></a>00123 <span class="keywordflow">if</span>( fgets( keyline, 1023, keys ) == NULL )
<a name="l00124"></a>00124 {
<a name="l00125"></a>00125 need_update = <span class="keyword">false</span>;
<a name="l00126"></a>00126 <span class="keywordflow">break</span>;
<a name="l00127"></a>00127 }
<a name="l00128"></a>00128 <span class="keywordflow">if</span>( <span class="keywordtype">char</span>* nl = strchr( keyline, <span class="charliteral">'\n'</span> ))
<a name="l00129"></a>00129 *nl = <span class="charliteral">'\0'</span>;
<a name="l00130"></a>00130 <span class="keywordtype">char</span> line[ 1024 ];
<a name="l00131"></a>00131 <span class="keywordflow">if</span>( fgets( line, 1023, config ) == NULL )
<a name="l00132"></a>00132 <span class="keywordflow">break</span>;
<a name="l00133"></a>00133 <span class="keywordflow">if</span>( <span class="keywordtype">char</span>* nl = strchr( line, <span class="charliteral">'\n'</span> ))
<a name="l00134"></a>00134 *nl = <span class="charliteral">'\0'</span>;
<a name="l00135"></a>00135 <span class="keywordflow">if</span>( strcmp( keyline, line ) != 0 )
<a name="l00136"></a>00136 <span class="keywordflow">break</span>;
<a name="l00137"></a>00137 <span class="keywordtype">bool</span> ok = <span class="keyword">false</span>;
<a name="l00138"></a>00138 <span class="keywordflow">for</span>(;;)
<a name="l00139"></a>00139 {
<a name="l00140"></a>00140 <span class="keywordflow">if</span>( fgets( line, 1023, config ) == NULL )
<a name="l00141"></a>00141 <span class="keywordflow">break</span>;
<a name="l00142"></a>00142 <span class="keywordflow">if</span>( <span class="keywordtype">char</span>* nl = strchr( line, <span class="charliteral">'\n'</span> ))
<a name="l00143"></a>00143 *nl = <span class="charliteral">'\0'</span>;
<a name="l00144"></a>00144 <span class="keywordflow">if</span>( *line == <span class="charliteral">'\0'</span> )
<a name="l00145"></a>00145 <span class="keywordflow">break</span>;
<a name="l00146"></a>00146 <span class="keywordflow">if</span>( *line == <span class="charliteral">'*'</span> )
<a name="l00147"></a>00147 {
<a name="l00148"></a>00148 ok = <span class="keyword">true</span>;
<a name="l00149"></a>00149 <span class="keywordflow">break</span>;
<a name="l00150"></a>00150 }
<a name="l00151"></a>00151 <span class="keywordflow">if</span>( *line == <span class="charliteral">'!'</span> )
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 <span class="keywordflow">if</span>( access( line + 1, R_OK ) == 0 )
<a name="l00154"></a>00154 <span class="keywordflow">break</span>; <span class="comment">// file now exists -> update</span>
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156 <span class="keywordflow">else</span>
<a name="l00157"></a>00157 {
<a name="l00158"></a>00158 <span class="keyword">struct </span>stat st;
<a name="l00159"></a>00159 <span class="keywordflow">if</span>( stat( line, &st ) != 0 )
<a name="l00160"></a>00160 <span class="keywordflow">break</span>;
<a name="l00161"></a>00161 <span class="keywordflow">if</span>( st.st_mtime > config_time )
<a name="l00162"></a>00162 <span class="keywordflow">break</span>;
<a name="l00163"></a>00163 }
<a name="l00164"></a>00164 }
<a name="l00165"></a>00165 <span class="keywordflow">if</span>( !ok )
<a name="l00166"></a>00166 <span class="keywordflow">break</span>;
<a name="l00167"></a>00167 }
<a name="l00168"></a>00168 fclose( keys );
<a name="l00169"></a>00169 fclose( config );
<a name="l00170"></a>00170 <span class="keywordflow">if</span>( need_update )
<a name="l00171"></a>00171 {
<a name="l00172"></a>00172 <span class="keywordtype">int</span> ret = system( <span class="stringliteral">"kdostartupconfig"</span> );
<a name="l00173"></a>00173 <span class="keywordflow">return</span> WEXITSTATUS( ret );
<a name="l00174"></a>00174 }
<a name="l00175"></a>00175 <span class="keywordflow">return</span> 0;
<a name="l00176"></a>00176 }
</pre></div></div>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kinit</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="files.html">File List</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
