cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-25 05:56:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_posix_filesystem_link_factory_8cs_source.html
T

162 lines
20 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tgstation-server: src/Tgstation.Server.Host/IO/PosixFilesystemLinkFactory.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.19.3</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_a536e49cdf631f66733cf2c9791144ce.html">IO</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">PosixFilesystemLinkFactory.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_posix_filesystem_link_factory_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.IO.Abstractions;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Threading;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System.Threading.Tasks;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>Mono.Unix;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_i_o.html">Tgstation.Server.Host.IO</a></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html"> 13</a></span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html">PosixFilesystemLinkFactory</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_filesystem_link_factory.html">IFilesystemLinkFactory</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a0b0d28882b7a82fb588e5cad8d37131d"> 16</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a0b0d28882b7a82fb588e5cad8d37131d">SymlinkedDirectoriesAreDeletedAsFiles</a> =&gt; <span class="keyword">true</span>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#aa66f3e78f468a162550a035dca9d00ba"> 21</a></span> readonly IFileSystem <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#aa66f3e78f468a162550a035dca9d00ba">fileSystem</a>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a88874947dc134e5be0bbabd930b083f6"> 27</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a88874947dc134e5be0bbabd930b083f6">PosixFilesystemLinkFactory</a>(IFileSystem <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#aa66f3e78f468a162550a035dca9d00ba">fileSystem</a>)</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> this.fileSystem = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#aa66f3e78f468a162550a035dca9d00ba">fileSystem</a> ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#aa66f3e78f468a162550a035dca9d00ba">fileSystem</a>));</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> }</div>
</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a56b0977edc79674c15d46bf685e1f618"> 33</a></span> <span class="keyword">public</span> Task <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a56b0977edc79674c15d46bf685e1f618">CreateHardLink</a>(<span class="keywordtype">string</span> targetPath, <span class="keywordtype">string</span> linkPath, CancellationToken cancellationToken) =&gt; Task.Factory.StartNew(</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> () =&gt;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> ArgumentNullException.ThrowIfNull(targetPath);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> ArgumentNullException.ThrowIfNull(linkPath);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> cancellationToken.ThrowIfCancellationRequested();</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> var fsInfo = <span class="keyword">new</span> UnixFileInfo(targetPath);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> cancellationToken.ThrowIfCancellationRequested();</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> fsInfo.CreateLink(linkPath);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> },</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> cancellationToken,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_default_i_o_manager.html">DefaultIOManager</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_default_i_o_manager.html#ac6dfeef4e622bb46047169215099995d">BlockingTaskCreationOptions</a>,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> TaskScheduler.Current);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a34da1a60dbfe433296c00fce1b0d4a7f"> 49</a></span> <span class="keyword">public</span> Task <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a34da1a60dbfe433296c00fce1b0d4a7f">CreateSymbolicLink</a>(<span class="keywordtype">string</span> targetPath, <span class="keywordtype">string</span> linkPath, CancellationToken cancellationToken) =&gt; Task.Factory.StartNew(</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> () =&gt;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> ArgumentNullException.ThrowIfNull(targetPath);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> ArgumentNullException.ThrowIfNull(linkPath);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> UnixFileSystemInfo fsInfo;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> var isFile = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#aa66f3e78f468a162550a035dca9d00ba">fileSystem</a>.File.Exists(targetPath);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> cancellationToken.ThrowIfCancellationRequested();</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordflow">if</span> (isFile)</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> fsInfo = <span class="keyword">new</span> UnixFileInfo(targetPath);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> fsInfo = <span class="keyword">new</span> UnixDirectoryInfo(targetPath);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> cancellationToken.ThrowIfCancellationRequested();</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> fsInfo.CreateSymbolicLink(linkPath);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> },</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> cancellationToken,</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_default_i_o_manager.html">DefaultIOManager</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_default_i_o_manager.html#ac6dfeef4e622bb46047169215099995d">BlockingTaskCreationOptions</a>,</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> TaskScheduler.Current);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> }</div>
</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_default_i_o_manager_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_default_i_o_manager.html">Tgstation.Server.Host.IO.DefaultIOManager</a></div><div class="ttdoc">IIOManager that resolves paths to Environment.CurrentDirectory.</div><div class="ttdef"><b>Definition</b> <a href="_default_i_o_manager_8cs_source.html#l00018">DefaultIOManager.cs:19</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_default_i_o_manager_html_ac6dfeef4e622bb46047169215099995d"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_default_i_o_manager.html#ac6dfeef4e622bb46047169215099995d">Tgstation.Server.Host.IO.DefaultIOManager.BlockingTaskCreationOptions</a></div><div class="ttdeci">const TaskCreationOptions BlockingTaskCreationOptions</div><div class="ttdoc">The TaskCreationOptions used to spawn Tasks for potentially long running, blocking operations.</div><div class="ttdef"><b>Definition</b> <a href="_default_i_o_manager_8cs_source.html#l00033">DefaultIOManager.cs:33</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html">Tgstation.Server.Host.IO.PosixFilesystemLinkFactory</a></div><div class="ttdoc">IFilesystemLinkFactory for POSIX systems.</div><div class="ttdef"><b>Definition</b> <a href="_posix_filesystem_link_factory_8cs_source.html#l00013">PosixFilesystemLinkFactory.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory_html_a0b0d28882b7a82fb588e5cad8d37131d"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a0b0d28882b7a82fb588e5cad8d37131d">Tgstation.Server.Host.IO.PosixFilesystemLinkFactory.SymlinkedDirectoriesAreDeletedAsFiles</a></div><div class="ttdeci">bool SymlinkedDirectoriesAreDeletedAsFiles</div><div class="ttdoc">If directory symlinks must be deleted as files would in the current environment.This is because Linux...</div><div class="ttdef"><b>Definition</b> <a href="_posix_filesystem_link_factory_8cs_source.html#l00016">PosixFilesystemLinkFactory.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory_html_a34da1a60dbfe433296c00fce1b0d4a7f"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a34da1a60dbfe433296c00fce1b0d4a7f">Tgstation.Server.Host.IO.PosixFilesystemLinkFactory.CreateSymbolicLink</a></div><div class="ttdeci">Task CreateSymbolicLink(string targetPath, string linkPath, CancellationToken cancellationToken)</div><div class="ttdoc">Create a symbolic link.A Task representing the running operation.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory_html_a56b0977edc79674c15d46bf685e1f618"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a56b0977edc79674c15d46bf685e1f618">Tgstation.Server.Host.IO.PosixFilesystemLinkFactory.CreateHardLink</a></div><div class="ttdeci">Task CreateHardLink(string targetPath, string linkPath, CancellationToken cancellationToken)</div><div class="ttdoc">Creates a hard link.A Task representing the running operation.</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory_html_a88874947dc134e5be0bbabd930b083f6"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#a88874947dc134e5be0bbabd930b083f6">Tgstation.Server.Host.IO.PosixFilesystemLinkFactory.PosixFilesystemLinkFactory</a></div><div class="ttdeci">PosixFilesystemLinkFactory(IFileSystem fileSystem)</div><div class="ttdoc">Initializes a new instance of the PosixFilesystemLinkFactory class.</div><div class="ttdef"><b>Definition</b> <a href="_posix_filesystem_link_factory_8cs_source.html#l00027">PosixFilesystemLinkFactory.cs:27</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory_html_aa66f3e78f468a162550a035dca9d00ba"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_posix_filesystem_link_factory.html#aa66f3e78f468a162550a035dca9d00ba">Tgstation.Server.Host.IO.PosixFilesystemLinkFactory.fileSystem</a></div><div class="ttdeci">readonly IFileSystem fileSystem</div><div class="ttdoc">The IFileSystem to use.</div><div class="ttdef"><b>Definition</b> <a href="_posix_filesystem_link_factory_8cs_source.html#l00021">PosixFilesystemLinkFactory.cs:21</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_filesystem_link_factory_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_filesystem_link_factory.html">Tgstation.Server.Host.IO.IFilesystemLinkFactory</a></div><div class="ttdoc">For creating filesystem symbolic links.</div><div class="ttdef"><b>Definition</b> <a href="_i_filesystem_link_factory_8cs_source.html#l00009">IFilesystemLinkFactory.cs:10</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_i_o_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_i_o.html">Tgstation.Server.Host.IO</a></div><div class="ttdef"><b>Definition</b> <a href="_buffered_file_stream_provider_8cs_source.html#l00008">BufferedFileStreamProvider.cs:9</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink