Merge pull request #240 from apache/Feature/239-Android-Support

FreeAndNil · web-flow · commit 088edbb5a2fb · 2025-04-29T15:30:08.000+02:00
#239 detect Android and use environment variables instead of AppSettings
diff --git a/doc/MailTemplate.Announce.txt b/doc/MailTemplate.Announce.txt
@@ -1,10 +1,10 @@
 To: announce@apache.org, dev@logging.apache.org
-Subject: [ANNOUNCE] Apache log4net 3.0.5 released
+Subject: [ANNOUNCE] Apache log4net 3.1.0 released
 
 Hi,
 
-the Apache log4net team is pleased to announce the 3.0.5 release.
+the Apache log4net team is pleased to announce the 3.1.0 release.
 For further information (support, download, etc.) see
 - https://logging.apache.org/log4net/release/release-notes.html
-- https://github.com/apache/logging-log4net/releases/tag/rel%2F3.0.5
-- https://www.nuget.org/packages/log4net/3.0.5
+- https://github.com/apache/logging-log4net/releases/tag/rel%2F3.1.0
+- https://www.nuget.org/packages/log4net/3.1.0
diff --git a/doc/MailTemplate.Result.txt b/doc/MailTemplate.Result.txt
@@ -1,5 +1,5 @@
 To: dev@logging.apache.org
-Subject: [RESULT][VOTE] Release Apache Log4net 3.0.5
+Subject: [RESULT][VOTE] Release Apache Log4net 3.1.0
 
 and here is my +1.
 
@@ -9,6 +9,6 @@ I will continue the release process.
 Jan
 
 ---------------------------------------------------------------------------------------------------
-This is a vote to release the Apache Log4net 3.0.5.
+This is a vote to release the Apache Log4net 3.1.0.
 
 ...
diff --git a/doc/MailTemplate.txt b/doc/MailTemplate.txt
@@ -1,12 +1,12 @@
 To: dev@logging.apache.org
-Subject: [VOTE] Release Apache Log4net 3.0.5
+Subject: [VOTE] Release Apache Log4net 3.1.0
 
-This is a vote to release the Apache Log4net 3.0.5.
+This is a vote to release the Apache Log4net 3.1.0.
 
 Website: https://logging.staged.apache.org/log4net/release/release-notes.html
 GitHub: https://github.com/apache/logging-log4net
 Commit: <todo insert>
-Distribution: https://dist.apache.org/repos/dist/dev/logging/log4net/3.0.5
+Distribution: https://dist.apache.org/repos/dist/dev/logging/log4net/3.1.0
 Signing key: 0x7D24496A230E29D6349A99EF583E491578F02D5D
 Review kit: https://logging.apache.org/log4net/release/release-review-instructions.html
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "log4net",
-  "version": "3.0.5",
+  "version": "3.1.0",
   "description": "Log4Net is a logging framework for .NET",
   "scripts": {
     "test": "run-s clean-build test-dotnet run-dotnet-core-tests",
@@ -47,4 +47,4 @@
     "@antora/site-generator-default": "^3.2.0-alpha.4",
     "@asciidoctor/tabs": "^1.0.0-beta.6"
   }
-}
+}
diff --git a/pom.xml b/pom.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+﻿<?xml version="1.0" encoding="UTF-8"?>
 <!--
   ~ Licensed to the Apache Software Foundation (ASF) under one or more
   ~ contributor license agreements.  See the NOTICE file distributed with
@@ -15,40 +15,30 @@
   ~ See the License for the specific language governing permissions and
   ~ limitations under the License.
   -->
-<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
-         child.project.url.inherit.append.path="false"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" child.project.url.inherit.append.path="false" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>
-
   <parent>
     <groupId>org.apache.logging</groupId>
     <artifactId>logging-parent</artifactId>
     <version>12.1.0</version>
   </parent>
-
   <packaging>pom</packaging>
   <groupId>org.apache.logging.log4net</groupId>
   <artifactId>apache-log4net</artifactId>
   <version>${revision}</version>
-
   <name>Apache log4net</name>
   <description>Logging framework for Microsoft .NET Framework.</description>
   <url>https://logging.apache.org/log4net</url>
   <inceptionYear>2004</inceptionYear>
-
-  <scm child.scm.connection.inherit.append.path="false" child.scm.developerConnection.inherit.append.path="false"
-       child.scm.url.inherit.append.path="false">
+  <scm child.scm.connection.inherit.append.path="false" child.scm.developerConnection.inherit.append.path="false" child.scm.url.inherit.append.path="false">
     <connection>scm:git:https://github.com/apache/logging-log4net</connection>
     <developerConnection>scm:git:https://github.com/apache/logging-log4net</developerConnection>
     <url>https://github.com/apache/logging-log4net</url>
   </scm>
-
   <issueManagement>
     <system>GitHub Issues</system>
     <url>https://github.com/apache/logging-log4net/issues</url>
   </issueManagement>
-
   <mailingLists>
     <mailingList>
       <name>logging commits: all git commits of the logging projects including log4net</name>
@@ -58,17 +48,14 @@
       <archive>https://mail-archives.apache.org/mod_mbox/logging-commits/</archive>
     </mailingList>
   </mailingLists>
-
   <ciManagement>
     <system>GitHub Actions</system>
     <url>https://github.com/apache/logging-log4net/actions</url>
   </ciManagement>
-
   <properties>
     <!-- project version -->
     <revision>3.1.0-SNAPSHOT</revision>
   </properties>
-
   <build>
     <plugins>
       <plugin>
diff --git a/scripts/build-preview.ps1 b/scripts/build-preview.ps1
@@ -1,5 +1,7 @@
-$Version = '3.0.5'
-$Preview = '1'
+param(
+  $Version = '3.1.0',
+  $Preview = '3'
+)
 'building ...'
 dotnet build -c Release "-p:GeneratePackages=true;PackageVersion=$Version-preview.$Preview" $PSScriptRoot/../src/log4net/log4net.csproj
 'signing ...'
diff --git a/src/changelog/3.1,0/209-migrate-log4net-site-to-antora.xml b/src/changelog/3.1,0/209-migrate-log4net-site-to-antora.xml
@@ -6,5 +6,5 @@
   <issue id="209" link="https://github.com/apache/logging-log4net/issues/209"/>
   <issue id="210" link="https://github.com/apache/logging-log4net/pull/210"/>
   <description format="asciidoc">Migrate the log4net site to Antora and use logging-parent pom
-  (implemented by @freeandnil in https://github.com/apache/logging-log4net/pull/210[#210])</description>
+  (implemented by @FreeAndNil in https://github.com/apache/logging-log4net/pull/210[#210])</description>
 </entry>
diff --git a/src/changelog/3.1,0/231-rollingfileappender.xml b/src/changelog/3.1,0/231-rollingfileappender.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns="https://logging.apache.org/xml/ns"
+       xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+       type="fixed">
+  <issue id="163" link="https://github.com/apache/logging-log4net/issues/163"/>
+  <issue id="231" link="https://github.com/apache/logging-log4net/issues/231"/>
+  <issue id="232" link="https://github.com/apache/logging-log4net/pull/232"/>
+  <issue id="236" link="https://github.com/apache/logging-log4net/issues/236"/>
+  <description format="asciidoc">RollingFileAppender does not respect the MaxSizeRollBackups with positive CountDirection
+  (implemented by @gdziadkiewicz in https://github.com/apache/logging-log4net/pull/232[#232])</description>
+</entry>
diff --git a/src/changelog/3.1,0/239-android.xml b/src/changelog/3.1,0/239-android.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns="https://logging.apache.org/xml/ns"
+       xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+       type="added">
+  <issue id="239" link="https://github.com/apache/logging-log4net/issues/239"/>
+  <issue id="240" link="https://github.com/apache/logging-log4net/pull/240"/>
+  <description format="asciidoc">detect Android and use environment variables instead of AppSettings
+  (reported by @arunjose696, implemented by @FreeAndNil in https://github.com/apache/logging-log4net/pull/240[#240])</description>
+</entry>
diff --git a/src/log4net.Tests/Util/SystemInfoTest.cs b/src/log4net.Tests/Util/SystemInfoTest.cs
@@ -166,4 +166,9 @@ public void EqualsIgnoringCase_SameStringsDifferentCase_true()
   [Test]
   public void EqualsIgnoringCase_DifferentStrings_false()
     => Assert.That(SystemInfo.EqualsIgnoringCase("foo", "foobar"), Is.False);
-}
+
+  [Test]
+  [Platform(Include = "Win,Linux,MacOsX")]
+  public void IsAndoid()
+    => Assert.That(typeof(SystemInfo).GetProperty("IsAndroid", BindingFlags.Static | BindingFlags.NonPublic)?.GetValue(null), Is.False);
+}
diff --git a/src/log4net/Appender/AdoNetAppender.cs b/src/log4net/Appender/AdoNetAppender.cs
@@ -449,10 +449,7 @@ protected override void SendBuffer(LoggingEvent[] events)
   /// Adds a parameter to the ordered list of command parameters.
   /// </para>
   /// </remarks>
-  public void AddParameter(AdoNetAppenderParameter parameter)
-  {
-    m_parameters.Add(parameter);
-  }
+  public void AddParameter(AdoNetAppenderParameter parameter) => m_parameters.Add(parameter);
 
   /// <summary>
   /// Writes the events to the database using the transaction specified.
diff --git a/src/log4net/Core/DefaultRepositorySelector.cs b/src/log4net/Core/DefaultRepositorySelector.cs
@@ -469,10 +469,8 @@ public void AliasRepository(string repositoryAlias, ILoggerRepository repository
   /// Raises the <see cref="LoggerRepositoryCreatedEvent"/> event.
   /// </para>
   /// </remarks>
-  protected virtual void OnLoggerRepositoryCreatedEvent(ILoggerRepository repository)
-  {
-    LoggerRepositoryCreatedEvent?.Invoke(this, new LoggerRepositoryCreationEventArgs(repository));
-  }
+  protected virtual void OnLoggerRepositoryCreatedEvent(ILoggerRepository repository) 
+    => LoggerRepositoryCreatedEvent?.Invoke(this, new(repository));
 
   /// <summary>
   /// Gets the repository name and repository type for the specified assembly.
diff --git a/src/log4net/Util/SystemInfo.cs b/src/log4net/Util/SystemInfo.cs
@@ -36,6 +36,11 @@ public static class SystemInfo
   private const string DefaultNullText = "(null)";
   private const string DefaultNotAvailableText = "NOT AVAILABLE";
 
+  /// <summary>
+  /// Is OperatingSystem Android
+  /// </summary>
+  internal static bool IsAndroid { get; } = IsAndroidCore();
+
   /// <summary>
   /// Initialize default values for private static fields.
   /// </summary>
@@ -68,6 +73,34 @@ static SystemInfo()
     NullText = nullText;
   }
 
+  private static bool IsAndroidCore() // https://stackoverflow.com/questions/47521008/how-can-i-distinguish-between-unix-and-android-on-netstandard-2-0
+  {
+    if (Environment.OSVersion.Platform != PlatformID.Unix)
+      return false;
+    using System.Diagnostics.Process process = new()
+    {
+      StartInfo = new()
+      {
+        FileName = "getprop",
+        Arguments = "ro.build.user",
+        RedirectStandardOutput = true,
+        UseShellExecute = false,
+        CreateNoWindow = true
+      }
+    };
+
+    try
+    {
+      process.Start();
+      string output = process.StandardOutput.ReadToEnd();
+      return !string.IsNullOrEmpty(output);
+    }
+    catch (Exception ex) when (!ex.IsFatal())
+    {
+      return false;
+    }
+  }
+
   /// <summary>
   /// Gets the system dependent line terminator.
   /// </summary>
@@ -414,10 +447,8 @@ public static string AssemblyFileName(Assembly myAssembly)
   /// then all the loaded assemblies will be searched for the type.
   /// </para>
   /// </remarks>
-  public static Type? GetTypeFromString(Type relativeType, string typeName, bool throwOnError, bool ignoreCase)
-  {
-    return GetTypeFromString(relativeType.EnsureNotNull().Assembly, typeName, throwOnError, ignoreCase);
-  }
+  public static Type? GetTypeFromString(Type relativeType, string typeName, bool throwOnError, bool ignoreCase) 
+    => GetTypeFromString(relativeType.EnsureNotNull().Assembly, typeName, throwOnError, ignoreCase);
 
   /// <summary>
   /// Loads the type specified in the type string.
@@ -438,10 +469,8 @@ public static string AssemblyFileName(Assembly myAssembly)
   /// in the assembly then all the loaded assemblies will be searched for the type.
   /// </para>
   /// </remarks>
-  public static Type? GetTypeFromString(string typeName, bool throwOnError, bool ignoreCase)
-  {
-    return GetTypeFromString(Assembly.GetCallingAssembly(), typeName, throwOnError, ignoreCase);
-  }
+  public static Type? GetTypeFromString(string typeName, bool throwOnError, bool ignoreCase) 
+    => GetTypeFromString(Assembly.GetCallingAssembly(), typeName, throwOnError, ignoreCase);
 
   /// <summary>
   /// Loads the type specified in the type string.
@@ -646,6 +675,8 @@ public static bool TryParse(string s, out short val)
   /// <returns>the value for the key, or <c>null</c></returns>
   public static string? GetAppSetting(string key)
   {
+    if (IsAndroid)
+      return Environment.GetEnvironmentVariable(key); // Android does not support config files
     try
     {
       return ConfigurationManager.AppSettings[key];
diff --git a/src/log4net/log4net.csproj b/src/log4net/log4net.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <Version>3.0.5</Version>
+    <Version>3.1.0</Version>
     <PackageId>log4net</PackageId>
     <Product>Apache log4net</Product>
     <Title>$(Product)</Title>
diff --git a/src/site/antora/modules/ROOT/pages/manual/configuration.adoc b/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
@@ -349,7 +349,6 @@ The section must specify the `log4net.Config.Log4NetConfigurationSectionHandler,
 
 The following is a simple example configuration file that specifies the correct section handler to use for the `log4net` section.
 
-
 [source,xml]
 ----
 <configuration>
@@ -427,6 +426,15 @@ The example shows how to embed configuration data in a .config file while allowi
 Since the .NET config parser throws errors for unregistered elements, the `log4net` section is registered using `System.Configuration.IgnoreSectionHandler`.
 This tells .NET to ignore the section, as it will be processed by log4net instead.
 
+[#android]
+== Android
+
+Android does not support `.config` files.
+
+Instead, you can set `AppSettings` values as environment variables for your process — this works only on Android.
+
+You must also load the `log4net` configuration manually, for example by reading it from an XML file at runtime.
+
 [#configuration-syntax]
 == Configuration Syntax
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "log4net",`
`3`		`- "version": "3.0.5",`
	`3`	`+ "version": "3.1.0",`
`4`	`4`	`"description": "Log4Net is a logging framework for .NET",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"test": "run-s clean-build test-dotnet run-dotnet-core-tests",`
`@@ -47,4 +47,4 @@`
`47`	`47`	`"@antora/site-generator-default": "^3.2.0-alpha.4",`
`48`	`48`	`"@asciidoctor/tabs": "^1.0.0-beta.6"`
`49`	`49`	`}`
`50`		`-}`
	`50`	`+}`